Skip to main content
Glama
test__basic__functionality_8py_source.html47 kB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=11"/> <meta name="generator" content="Doxygen 1.14.0"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Doxygen MCP Server: test_basic_functionality.py Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <script type="text/javascript" src="clipboard.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="cookie.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr id="projectrow"> <td id="projectalign"> <div id="projectname">Doxygen MCP Server </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.14.0 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search/",'.html'); </script> <script type="text/javascript"> $(function() { codefold.init(); }); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search',true); $(function() { init_search(); }); }); </script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(function(){initNavTree('test__basic__functionality_8py_source.html','',''); }); </script> <div id="container"> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <div id="MSearchResults"> <div class="SRPage"> <div id="SRIndex"> <div id="SRResults"></div> <div class="SRStatus" id="Loading">Loading...</div> <div class="SRStatus" id="Searching">Searching...</div> <div class="SRStatus" id="NoMatches">No Matches</div> </div> </div> </div> </div> <div class="header"> <div class="headertitle"><div class="title">test_basic_functionality.py</div></div> </div><!--header--> <div class="contents"> <a href="test__basic__functionality_8py.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html"> 1</a></span><span class="comment">#!/usr/bin/env python3</span></div> <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="stringliteral">&quot;&quot;&quot;</span></div> <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="stringliteral">Basic functionality test for Doxygen MCP Server</span></div> <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="stringliteral">Run this script to verify core functionality before MCP integration</span></div> <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="stringliteral">&quot;&quot;&quot;</span></div> <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div> <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">import</span> subprocess</div> <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">import</span> sys</div> <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">from</span> pathlib <span class="keyword">import</span> Path</div> <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">import</span> json</div> <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div> <div class="foldopen" id="foldopen00012" data-start="" data-end=""> <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html#a20f8a4315fe99eabed6d5d3d7767bd7b"> 12</a></span><span class="keyword">def </span><a class="code hl_function" href="namespacetest__basic__functionality.html#a20f8a4315fe99eabed6d5d3d7767bd7b">test_doxygen_installation</a>():</div> <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="stringliteral">&quot;&quot;&quot;Test if Doxygen is installed and accessible&quot;&quot;&quot;</span></div> <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> print(<span class="stringliteral">&quot;🔍 Testing Doxygen installation...&quot;</span>)</div> <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> result = subprocess.run([<span class="stringliteral">&quot;doxygen&quot;</span>, <span class="stringliteral">&quot;--version&quot;</span>], capture_output=<span class="keyword">True</span>, text=<span class="keyword">True</span>)</div> <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordflow">if</span> result.returncode == 0:</div> <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> version = result.stdout.strip()</div> <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> print(f<span class="stringliteral">&quot;✅ Doxygen {version} is installed and working!&quot;</span>)</div> <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">return</span> <span class="keyword">True</span></div> <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> print(<span class="stringliteral">&quot;❌ Doxygen is not working properly&quot;</span>)</div> <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> print(f<span class="stringliteral">&quot;Error: {result.stderr}&quot;</span>)</div> <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordflow">except</span> FileNotFoundError:</div> <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> print(<span class="stringliteral">&quot;❌ Doxygen is not installed or not in PATH&quot;</span>)</div> <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> print(<span class="stringliteral">&quot;Please install Doxygen from: https://www.doxygen.nl/download.html&quot;</span>)</div> <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> </div> <div class="foldopen" id="foldopen00030" data-start="" data-end=""> <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html#ac27421aecb54a318750ed93550b55c24"> 30</a></span><span class="keyword">def </span><a class="code hl_function" href="namespacetest__basic__functionality.html#ac27421aecb54a318750ed93550b55c24">test_graphviz_installation</a>():</div> <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="stringliteral">&quot;&quot;&quot;Test if Graphviz (dot) is installed&quot;&quot;&quot;</span></div> <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> print(<span class="stringliteral">&quot;\n🔍 Testing Graphviz (dot) installation...&quot;</span>)</div> <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> result = subprocess.run([<span class="stringliteral">&quot;dot&quot;</span>, <span class="stringliteral">&quot;-V&quot;</span>], capture_output=<span class="keyword">True</span>, text=<span class="keyword">True</span>)</div> <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">if</span> result.returncode == 0:</div> <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="comment"># Graphviz outputs version to stderr</span></div> <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> version_info = result.stderr.strip()</div> <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> print(f<span class="stringliteral">&quot;✅ Graphviz found: {version_info}&quot;</span>)</div> <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordflow">return</span> <span class="keyword">True</span></div> <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> print(<span class="stringliteral">&quot;❌ Graphviz dot command failed&quot;</span>)</div> <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">except</span> FileNotFoundError:</div> <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> print(<span class="stringliteral">&quot;⚠️ Graphviz (dot) not found - diagrams will not be generated&quot;</span>)</div> <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> print(<span class="stringliteral">&quot;Install from: https://graphviz.org/download/&quot;</span>)</div> <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div> </div> <div class="foldopen" id="foldopen00048" data-start="" data-end=""> <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html#a08648199817f169e9a5817fa17b008bb"> 48</a></span><span class="keyword">def </span><a class="code hl_function" href="namespacetest__basic__functionality.html#a08648199817f169e9a5817fa17b008bb">test_python_dependencies</a>():</div> <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="stringliteral">&quot;&quot;&quot;Test if required Python packages are available&quot;&quot;&quot;</span></div> <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> print(<span class="stringliteral">&quot;\n🔍 Testing Python dependencies...&quot;</span>)</div> <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> required_packages = [<span class="stringliteral">&#39;mcp&#39;</span>, <span class="stringliteral">&#39;pydantic&#39;</span>]</div> <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> missing_packages = []</div> <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div> <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">for</span> package <span class="keywordflow">in</span> required_packages:</div> <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> __import__(package)</div> <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> print(f<span class="stringliteral">&quot;✅ {package} is available&quot;</span>)</div> <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordflow">except</span> ImportError:</div> <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> print(f<span class="stringliteral">&quot;❌ {package} is missing&quot;</span>)</div> <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> missing_packages.append(package)</div> <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div> <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">if</span> missing_packages:</div> <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> print(f<span class="stringliteral">&quot;\n⚠️ Missing packages: {&#39;, &#39;.join(missing_packages)}&quot;</span>)</div> <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> print(<span class="stringliteral">&quot;Install with: pip install -r requirements.txt&quot;</span>)</div> <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keywordflow">return</span> <span class="keyword">True</span></div> <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> </div> <div class="foldopen" id="foldopen00068" data-start="" data-end=""> <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html#aece4f4551ecfcb0e83bce5885c489cf8"> 68</a></span><span class="keyword">def </span><a class="code hl_function" href="namespacetest__basic__functionality.html#aece4f4551ecfcb0e83bce5885c489cf8">test_project_structure</a>():</div> <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="stringliteral">&quot;&quot;&quot;Test if all required project files are present&quot;&quot;&quot;</span></div> <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> print(<span class="stringliteral">&quot;\n🔍 Testing project structure...&quot;</span>)</div> <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> project_root = Path(__file__).parent</div> <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> required_files = [</div> <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="stringliteral">&#39;server.py&#39;</span>,</div> <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="stringliteral">&#39;requirements.txt&#39;</span>,</div> <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="stringliteral">&#39;package.json&#39;</span>,</div> <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="stringliteral">&#39;README.md&#39;</span>,</div> <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="stringliteral">&#39;templates/minimal.doxyfile&#39;</span>,</div> <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="stringliteral">&#39;templates/standard.doxyfile&#39;</span>,</div> <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="stringliteral">&#39;templates/comprehensive.doxyfile&#39;</span>,</div> <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="stringliteral">&#39;examples/cpp_sample/calculator.h&#39;</span>,</div> <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="stringliteral">&#39;examples/cpp_sample/calculator.cpp&#39;</span></div> <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> ]</div> <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> missing_files = []</div> <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="keywordflow">for</span> file_path <span class="keywordflow">in</span> required_files:</div> <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> full_path = project_root / file_path</div> <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">if</span> full_path.exists():</div> <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> print(f<span class="stringliteral">&quot;✅ {file_path}&quot;</span>)</div> <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> print(f<span class="stringliteral">&quot;❌ {file_path}&quot;</span>)</div> <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> missing_files.append(file_path)</div> <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div> <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordflow">if</span> missing_files:</div> <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> print(f<span class="stringliteral">&quot;\n⚠️ Missing files: {&#39;, &#39;.join(missing_files)}&quot;</span>)</div> <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordflow">return</span> <span class="keyword">True</span></div> <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div> </div> <div class="foldopen" id="foldopen00099" data-start="" data-end=""> <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html#abd1c318c6260da6559fcd7dad0d45746"> 99</a></span><span class="keyword">def </span><a class="code hl_function" href="namespacetest__basic__functionality.html#abd1c318c6260da6559fcd7dad0d45746">test_example_project</a>():</div> <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="stringliteral">&quot;&quot;&quot;Test the example C++ project&quot;&quot;&quot;</span></div> <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> print(<span class="stringliteral">&quot;\n🔍 Testing example C++ project...&quot;</span>)</div> <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div> <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> project_root = Path(__file__).parent</div> <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> example_path = project_root / <span class="stringliteral">&quot;examples&quot;</span> / <span class="stringliteral">&quot;cpp_sample&quot;</span></div> <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div> <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="comment"># Count source files</span></div> <div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> cpp_files = list(example_path.glob(<span class="stringliteral">&quot;*.cpp&quot;</span>))</div> <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> h_files = list(example_path.glob(<span class="stringliteral">&quot;*.h&quot;</span>))</div> <div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div> <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> print(f<span class="stringliteral">&quot;📄 Found {len(cpp_files)} .cpp files&quot;</span>)</div> <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> print(f<span class="stringliteral">&quot;📄 Found {len(h_files)} .h files&quot;</span>)</div> <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="comment"># Check if files have Doxygen comments</span></div> <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> documented_files = 0</div> <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keywordflow">for</span> file_path <span class="keywordflow">in</span> cpp_files + h_files:</div> <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> content = file_path.read_text(encoding=<span class="stringliteral">&#39;utf-8&#39;</span>)</div> <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keywordflow">if</span> <span class="stringliteral">&#39;/**&#39;</span> <span class="keywordflow">in</span> content <span class="keywordflow">or</span> <span class="stringliteral">&#39;///&#39;</span> <span class="keywordflow">in</span> content <span class="keywordflow">or</span> <span class="stringliteral">&#39;@brief&#39;</span> <span class="keywordflow">in</span> content:</div> <div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> documented_files += 1</div> <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> print(f<span class="stringliteral">&quot;✅ {file_path.name} has Doxygen comments&quot;</span>)</div> <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> print(f<span class="stringliteral">&quot;⚠️ {file_path.name} lacks Doxygen comments&quot;</span>)</div> <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div> <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> total_files = len(cpp_files) + len(h_files)</div> <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="keywordflow">if</span> total_files &gt; 0:</div> <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> print(f<span class="stringliteral">&quot;📊 Documentation coverage: {documented_files}/{total_files} files&quot;</span>)</div> <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> <span class="keywordflow">return</span> documented_files &gt; 0</div> <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> print(<span class="stringliteral">&quot;❌ No source files found in example project&quot;</span>)</div> <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div> </div> <div class="foldopen" id="foldopen00131" data-start="" data-end=""> <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html#ae19a04373a188145ab136d75923a00e6"> 131</a></span><span class="keyword">def </span><a class="code hl_function" href="namespacetest__basic__functionality.html#ae19a04373a188145ab136d75923a00e6">test_manual_doxygen_run</a>():</div> <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="stringliteral">&quot;&quot;&quot;Test running Doxygen manually on the example project&quot;&quot;&quot;</span></div> <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> print(<span class="stringliteral">&quot;\n🔍 Testing manual Doxygen run...&quot;</span>)</div> <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> </div> <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> project_root = Path(__file__).parent</div> <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> example_path = project_root / <span class="stringliteral">&quot;examples&quot;</span> / <span class="stringliteral">&quot;cpp_sample&quot;</span></div> <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> </div> <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="comment"># Create a simple Doxyfile for testing</span></div> <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> doxyfile_content = f<span class="stringliteral">&quot;&quot;&quot;</span></div> <div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="stringliteral">PROJECT_NAME = &quot;Calculator Example Test&quot;</span></div> <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="stringliteral">OUTPUT_DIRECTORY = &quot;{example_path}/test_docs&quot;</span></div> <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="stringliteral">INPUT = {example_path}</span></div> <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="stringliteral">FILE_PATTERNS = *.h *.cpp</span></div> <div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="stringliteral">RECURSIVE = NO</span></div> <div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="stringliteral">GENERATE_HTML = YES</span></div> <div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="stringliteral">GENERATE_LATEX = NO</span></div> <div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="stringliteral">EXTRACT_ALL = YES</span></div> <div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="stringliteral">SOURCE_BROWSER = YES</span></div> <div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="stringliteral">&quot;&quot;&quot;</span></div> <div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> </div> <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> doxyfile_path = example_path / <span class="stringliteral">&quot;Doxyfile.test&quot;</span></div> <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> doxyfile_path.write_text(doxyfile_content)</div> <div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div> <div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> print(f<span class="stringliteral">&quot;📝 Created test Doxyfile: {doxyfile_path}&quot;</span>)</div> <div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div> <div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <span class="comment"># Run Doxygen</span></div> <div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> result = subprocess.run(</div> <div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> [<span class="stringliteral">&quot;doxygen&quot;</span>, str(doxyfile_path)],</div> <div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> cwd=example_path,</div> <div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> capture_output=<span class="keyword">True</span>,</div> <div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> text=<span class="keyword">True</span></div> <div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> )</div> <div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> </div> <div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <span class="keywordflow">if</span> result.returncode == 0:</div> <div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> print(<span class="stringliteral">&quot;✅ Doxygen ran successfully!&quot;</span>)</div> <div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> </div> <div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> <span class="comment"># Check if HTML output was created</span></div> <div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> html_index = example_path / <span class="stringliteral">&quot;test_docs&quot;</span> / <span class="stringliteral">&quot;html&quot;</span> / <span class="stringliteral">&quot;index.html&quot;</span></div> <div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> <span class="keywordflow">if</span> html_index.exists():</div> <div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> print(f<span class="stringliteral">&quot;✅ HTML documentation created: {html_index}&quot;</span>)</div> <div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> print(f<span class="stringliteral">&quot;📊 Documentation size: {html_index.stat().st_size} bytes&quot;</span>)</div> <div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <span class="keywordflow">return</span> <span class="keyword">True</span></div> <div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> print(<span class="stringliteral">&quot;❌ HTML documentation not found&quot;</span>)</div> <div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> print(<span class="stringliteral">&quot;❌ Doxygen failed to run&quot;</span>)</div> <div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> print(f<span class="stringliteral">&quot;Error output: {result.stderr}&quot;</span>)</div> <div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> </div> <div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> <span class="keywordflow">except</span> Exception <span class="keyword">as</span> e:</div> <div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> print(f<span class="stringliteral">&quot;❌ Error running Doxygen test: {e}&quot;</span>)</div> <div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> <span class="keywordflow">finally</span>:</div> <div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> <span class="comment"># Clean up</span></div> <div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="keywordflow">if</span> doxyfile_path.exists():</div> <div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> doxyfile_path.unlink()</div> <div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div> </div> <div class="foldopen" id="foldopen00190" data-start="" data-end=""> <div class="line"><a id="l00190" name="l00190"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html#a50cdfa8ab5cbf4e550c5c092fad44d5e"> 190</a></span><span class="keyword">def </span><a class="code hl_function" href="namespacetest__basic__functionality.html#a50cdfa8ab5cbf4e550c5c092fad44d5e">main</a>():</div> <div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> <span class="stringliteral">&quot;&quot;&quot;Run all tests&quot;&quot;&quot;</span></div> <div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> print(<span class="stringliteral">&quot;🚀 Doxygen MCP Server - Basic Functionality Tests&quot;</span>)</div> <div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> print(<span class="stringliteral">&quot;=&quot;</span> * 60)</div> <div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div> <div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> tests = [</div> <div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> (<span class="stringliteral">&quot;Doxygen Installation&quot;</span>, test_doxygen_installation),</div> <div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> (<span class="stringliteral">&quot;Graphviz Installation&quot;</span>, test_graphviz_installation),</div> <div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> (<span class="stringliteral">&quot;Python Dependencies&quot;</span>, test_python_dependencies),</div> <div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> (<span class="stringliteral">&quot;Project Structure&quot;</span>, test_project_structure),</div> <div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> (<span class="stringliteral">&quot;Example Project&quot;</span>, test_example_project),</div> <div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> (<span class="stringliteral">&quot;Manual Doxygen Run&quot;</span>, test_manual_doxygen_run)</div> <div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> ]</div> <div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> </div> <div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> results = []</div> <div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> </div> <div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> <span class="keywordflow">for</span> test_name, test_func <span class="keywordflow">in</span> tests:</div> <div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <span class="keywordflow">try</span>:</div> <div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> success = test_func()</div> <div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> results.append((test_name, success))</div> <div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> <span class="keywordflow">except</span> Exception <span class="keyword">as</span> e:</div> <div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> print(f<span class="stringliteral">&quot;❌ {test_name} failed with exception: {e}&quot;</span>)</div> <div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> results.append((test_name, <span class="keyword">False</span>))</div> <div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> </div> <div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> <span class="comment"># Summary</span></div> <div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> print(<span class="stringliteral">&quot;\n&quot;</span> + <span class="stringliteral">&quot;=&quot;</span> * 60)</div> <div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> print(<span class="stringliteral">&quot;📊 Test Results Summary:&quot;</span>)</div> <div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> print(<span class="stringliteral">&quot;=&quot;</span> * 60)</div> <div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> </div> <div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> passed = 0</div> <div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> <span class="keywordflow">for</span> test_name, success <span class="keywordflow">in</span> results:</div> <div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> status = <span class="stringliteral">&quot;✅ PASS&quot;</span> <span class="keywordflow">if</span> success <span class="keywordflow">else</span> <span class="stringliteral">&quot;❌ FAIL&quot;</span></div> <div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> print(f<span class="stringliteral">&quot;{status} {test_name}&quot;</span>)</div> <div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> <span class="keywordflow">if</span> success:</div> <div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> passed += 1</div> <div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> </div> <div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> print(f<span class="stringliteral">&quot;\n🎯 Overall: {passed}/{len(results)} tests passed&quot;</span>)</div> <div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> </div> <div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> <span class="keywordflow">if</span> passed == len(results):</div> <div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> print(<span class="stringliteral">&quot;\n🎉 All tests passed! Ready for MCP integration testing.&quot;</span>)</div> <div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <span class="keywordflow">return</span> <span class="keyword">True</span></div> <div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> <span class="keywordflow">else</span>:</div> <div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> print(f<span class="stringliteral">&quot;\n⚠️ {len(results) - passed} tests failed. Please address issues before proceeding.&quot;</span>)</div> <div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> <span class="keywordflow">return</span> <span class="keyword">False</span></div> <div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> </div> </div> <div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span><span class="keywordflow">if</span> __name__ == <span class="stringliteral">&quot;__main__&quot;</span>:</div> <div class="line"><a id="l00236" name="l00236"></a><span class="lineno"><a class="line" href="namespacetest__basic__functionality.html#a9bcbc497cbe4567522f3978ee883b931"> 236</a></span> success = <a class="code hl_function" href="namespacetest__basic__functionality.html#a50cdfa8ab5cbf4e550c5c092fad44d5e">main</a>()</div> <div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> sys.exit(0 <span class="keywordflow">if</span> success <span class="keywordflow">else</span> 1)</div> <div class="ttc" id="anamespacetest__basic__functionality_html_a08648199817f169e9a5817fa17b008bb"><div class="ttname"><a href="namespacetest__basic__functionality.html#a08648199817f169e9a5817fa17b008bb">test_basic_functionality.test_python_dependencies</a></div><div class="ttdeci">test_python_dependencies()</div><div class="ttdef"><b>Definition</b> <a href="#l00048">test_basic_functionality.py:48</a></div></div> <div class="ttc" id="anamespacetest__basic__functionality_html_a20f8a4315fe99eabed6d5d3d7767bd7b"><div class="ttname"><a href="namespacetest__basic__functionality.html#a20f8a4315fe99eabed6d5d3d7767bd7b">test_basic_functionality.test_doxygen_installation</a></div><div class="ttdeci">test_doxygen_installation()</div><div class="ttdef"><b>Definition</b> <a href="#l00012">test_basic_functionality.py:12</a></div></div> <div class="ttc" id="anamespacetest__basic__functionality_html_a50cdfa8ab5cbf4e550c5c092fad44d5e"><div class="ttname"><a href="namespacetest__basic__functionality.html#a50cdfa8ab5cbf4e550c5c092fad44d5e">test_basic_functionality.main</a></div><div class="ttdeci">main()</div><div class="ttdef"><b>Definition</b> <a href="#l00190">test_basic_functionality.py:190</a></div></div> <div class="ttc" id="anamespacetest__basic__functionality_html_abd1c318c6260da6559fcd7dad0d45746"><div class="ttname"><a href="namespacetest__basic__functionality.html#abd1c318c6260da6559fcd7dad0d45746">test_basic_functionality.test_example_project</a></div><div class="ttdeci">test_example_project()</div><div class="ttdef"><b>Definition</b> <a href="#l00099">test_basic_functionality.py:99</a></div></div> <div class="ttc" id="anamespacetest__basic__functionality_html_ac27421aecb54a318750ed93550b55c24"><div class="ttname"><a href="namespacetest__basic__functionality.html#ac27421aecb54a318750ed93550b55c24">test_basic_functionality.test_graphviz_installation</a></div><div class="ttdeci">test_graphviz_installation()</div><div class="ttdef"><b>Definition</b> <a href="#l00030">test_basic_functionality.py:30</a></div></div> <div class="ttc" id="anamespacetest__basic__functionality_html_ae19a04373a188145ab136d75923a00e6"><div class="ttname"><a href="namespacetest__basic__functionality.html#ae19a04373a188145ab136d75923a00e6">test_basic_functionality.test_manual_doxygen_run</a></div><div class="ttdeci">test_manual_doxygen_run()</div><div class="ttdef"><b>Definition</b> <a href="#l00131">test_basic_functionality.py:131</a></div></div> <div class="ttc" id="anamespacetest__basic__functionality_html_aece4f4551ecfcb0e83bce5885c489cf8"><div class="ttname"><a href="namespacetest__basic__functionality.html#aece4f4551ecfcb0e83bce5885c489cf8">test_basic_functionality.test_project_structure</a></div><div class="ttdeci">test_project_structure()</div><div class="ttdef"><b>Definition</b> <a href="#l00068">test_basic_functionality.py:68</a></div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> </div><!-- container --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a href="test__basic__functionality_8py.html">test_basic_functionality.py</a></li> <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li> </ul> </div> </body> </html>

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Positronikal/doxygen-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server