Skip to content

Commit

Permalink
update 31507ea
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions authored and GitHub Actions committed Oct 27, 2023
0 parents commit 7e0a5f8
Show file tree
Hide file tree
Showing 67 changed files with 6,992 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: ed2675e08ceb924938934e77d59846f9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added .nojekyll
Empty file.
186 changes: 186 additions & 0 deletions Frontends.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Frontends &mdash; pyEDAA.Reports latest documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/documentation_options.js?v=c6e86fd7"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Index" href="genindex.html" />
<link rel="prev" title="Tracking requirements" href="Tracking.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> pyEDAA.Reports
</a>
<div class="version">
latest
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference external" href="https://edaa-org.github.io/">Used as a layer of EDA² ➚</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Reference.html">pyEDAA.Reports</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">About</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="FunctionalCoverage.html">Functional coverage</a></li>
<li class="toctree-l1"><a class="reference internal" href="LineCoverage.html">Line coverage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Resources.html">Synthesis and implementation results</a></li>
<li class="toctree-l1"><a class="reference internal" href="RichLogging.html">Semantic/rich logging</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tracking.html">Tracking requirements</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Frontends</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#open-source-verification-report-explorer">Open Source Verification Report Explorer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#github">GitHub</a></li>
<li class="toctree-l2"><a class="reference internal" href="#gitlab">GitLab</a></li>
<li class="toctree-l2"><a class="reference internal" href="#grafana">Grafana</a></li>
<li class="toctree-l2"><a class="reference internal" href="#references">References</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Module Index</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pyEDAA.Reports</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">


<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Frontends</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/edaa-org/pyEDAA.Reports/blob/main/doc/Frontends.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>

<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="frontends">
<h1>Frontends<a class="headerlink" href="#frontends" title="Link to this heading"></a></h1>
<p>Both GitHub and GitLab do provide features for displaying CI results through their web GUIs. Although they are not rich
enough for displaying all the details, OSVR generators can provide stripped down file formats matching some of the
supported readers; similarly to the JSON and xUnit outputs provided by VUnit.</p>
<section id="open-source-verification-report-explorer">
<span id="api-logging-osvre"></span><h2>Open Source Verification Report Explorer<a class="headerlink" href="#open-source-verification-report-explorer" title="Link to this heading"></a></h2>
<p>It would be interesting to have a vendor agnostic tool for visualizing reports locally and/or in self-hosted services.
Since XML, JSON or YAML are used, web technologies (HTML + CSS + JavaScript) feel like a sensible choice. Generating an
static page which can be hosted on GitHub Pages or GitLab Pages allows granular analysis of CI results, while also being
usable locally. There are several simple and not-so-simple solutions available for xUnit files:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.w3schools.com/howto/howto_js_treeview.asp">w3schools.com/howto/howto_js_treeview</a></p></li>
<li><p><a class="reference external" href="https://lukejpreston.github.io/xunit-viewer/">lukejpreston.github.io/xunit-viewer</a></p></li>
<li><p><a class="reference external" href="https://softwarerecs.stackexchange.com/questions/3666/standalone-junit-xml-report-viewer">Standalone JUnit XML report viewer</a></p></li>
<li><p><a class="reference external" href="https://docs.qameta.io/allure/">docs.qameta.io/allure</a></p></li>
<li><p><a class="reference external" href="https://github.com/inorton/junit2html">inorton/junit2html</a></p></li>
</ul>
<p>Similar solutions exist based on unittest or pytest:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/xmlrunner/unittest-xml-reporting">xmlrunner/unittest-xml-reporting</a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/pytest-reporter/">pytest-reporter</a></p>
<ul>
<li><p><a class="reference external" href="https://pypi.org/project/pytest-reporter-html1/">pytest-reporter-html1</a></p></li>
</ul>
</li>
</ul>
<p>As a complement, extending <a class="reference external" href="https://github.com/fvutils/pyucis-viewer">pyucis-viewer</a> might be evaluated, for providing
a Qt based solution. pyucis-viewer currently provides a simple bar-chart viewer for coverage data read via pyucis.</p>
</section>
<section id="github">
<h2>GitHub<a class="headerlink" href="#github" title="Link to this heading"></a></h2>
<p>Although there is no official feature for using the <a class="reference external" href="https://docs.github.com/en/rest/reference/checks">GitHub Checks</a>
API, there are some community actions for e.g. analysing xUnit files: <a class="reference external" href="https://github.com/marketplace/actions/publish-unit-test-results">publish-unit-test-results</a>. There are also multiple bindings in JavaScript, Python or golang for
interacting with GitHub’s API.</p>
</section>
<section id="gitlab">
<h2>GitLab<a class="headerlink" href="#gitlab" title="Link to this heading"></a></h2>
<p>Apart from <a class="reference external" href="https://docs.gitlab.com/ee/ci/unit_test_reports.html">unit test reports</a>, GitLab supports over a dozen
<a class="reference external" href="https://docs.gitlab.com/ee/ci/unit_test_reports.html">artifact reports</a>.</p>
</section>
<section id="grafana">
<h2>Grafana<a class="headerlink" href="#grafana" title="Link to this heading"></a></h2>
<p>On top of visualizing individual reports or sets of reports at one point in time, tracking the evolution of certain
metrics throughout the development of a project can provide valuable insight. GitLab does have a built-in <a class="reference external" href="https://prometheus.io/">Prometheus</a> monitoring system and <a class="reference external" href="https://grafana.com/">Grafana</a> can be optionally used as a dashboard:
<a class="reference external" href="https://docs.gitlab.com/omnibus/settings/grafana.html">docs.gitlab.com: Grafana Dashboard Service</a>. Therefore, it
would be useful to send OSVR reports to either Prometheus or some other temporal database (say Graphite, InfluxDB, etc.).</p>
</section>
<section id="references">
<h2>References<a class="headerlink" href="#references" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/EDAAC/EDAAC">EDAAC/EDAAC</a>: EDA Analytics Central</p></li>
</ul>
</section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Tracking.html" class="btn btn-neutral float-left" title="Tracking requirements" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="genindex.html" class="btn btn-neutral float-right" title="Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2021-2021 Patrick Lehmann - Boetzingen, Germany.
<span class="lastupdated">Last updated on 27.10.2023.
</span></p>
</div>Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/buildthedocs/sphinx.theme">theme</a>
provided by <a href="https://buildthedocs.github.io">Build the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 7e0a5f8

Please sign in to comment.