Skip to content

Add proper reports in documentation about the compatibility tests #426

@bertysentry

Description

@bertysentry

Requirements

In the documentation site, we want to have fancy reports about the compatibility of Jawk with various test suites:

  1. POSIX
  2. BWK
  3. gawk

Specifications

Jawk is tested against POSIX, BWK, and gawk test suites during mvn verify with failsafe Maven plugin. The plugin produces XML reports in the target/ directory:

  • TEST-io.jawk.gawk.*.xml for gawk test suite
  • TEST-io.jawk.onetrueawk.*.xml for bwk/One True Awk test suite
  • TEST-io.jawk.posix.*.xml for Posix test suite

compatibility.md

Change src/site/markdown/compatibility.md to a Velocity template: src/site/markdown/compatibility.md.vm that will parse these XML files (using the $xml Velocity tool) to create HTML to report the compatibility percentage in each test suite, in the form of a progress bar.

Note

The Maven site is rendered using Doxia and the Sentry Maven Skin, which includes Bootstrap 3 and UIB AngularJS components. You can therefore use this HTML syntax:

    <div class="row">
        <div class="col-sm-4"><div uib-progressbar="" value="55"></div></div>
       <div class="col-sm-4"><div uib-progressbar="" class="progress-striped" value="22" type="warning">22%</div></div>
        <div class="col-sm-4"><div uib-progressbar="" class="progress-striped active" max="200" value="166" type="danger"><i>166 / 200</i></div></div>
   </div>

Doxia requires that we use <div> or <span> elements instead of <uib-progressbar>.

Then we could build a sort of map, like old disk defrag tools, with each small square representing one test case, in green if successful, red when error or failed, gray when skipped.

Each test suite (gawk, One True Awk, POSIX) would have its own map.

And then a link to the failsafe report (to /failsafe.html) for more information.

The rest of this page must be curated. We can remove the list of test suites that describes the different tests, but each description should be integrated into the above graphical representation. Compatibility must be at the top of the page. The story of Jawk and its previous versions is much less important.

index.md

Ideally, we could also update index.md into index.md.vm to show the same progress bars prominently, or rating, or donut charts (although we don't have the necessary library for that).

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions