jeremiah-c-leary / eda-log-file-warning-suppressor

Suppresses warnings in EDA logfiles.

EDA Log File Warning Suppressor (ELFWS)

Suppresses warnings in EDA logfiles.

Table of Contents

• Overview
• Key Benefits
• Key Features
• Installation
• Usage
• Documentation
• Contributing

Overview

ELFWS was created after going through warning triage for an FPGA design. The synthesis tool provided the ability to suppress warnings, but only at the warning id level. The place and route tool did not supply any ability to suppress warnings. Eventually a design change induced a new warning. Unfortunately, it was not detected until much later in the design process. A design change was required to resolve the warning. The change was minor, but could have resulted in major design changes if it could not have been resolved.

Key Benefits

• Standardizes warning suppression definition
• Provides warning suppression for tools that do not support suppressions

Key Features

• Warning definition
  • Uses YAML to define suppression rules
  • Can include justifications for warning suppression
• Continuous Integration tool support
  • command line tool
  • outputs JUnit XML files
• Audit Reports
  • which rules suppressed which warnings
  • rules which did not suppress any warnings
  • warnings which were suppressed by multiple rules

Installation

You can get the latest released version of ELFWS via pip.

pip install elfws

The latest development version can be cloned...

git clone https://github.com/jeremiah-c-leary/eda-log-file-warning-supressor.git

...and then installed locally...

python setup.py install

Usage

ELFWS can be invoked using elfws at the command line prompt:

$ elfws
usage: elfws [-h] {create,report,show,suppress,version} ...

Suppresses Warnings in logfiles.

positional arguments:
  {create,report,show,suppress,version}
    create              Create suppression file
    report              Generate an audit report
    show                Show warnings in logfiles
    suppress            Suppresses warnings in logfiles
    version             Displays ELFWS version information

optional arguments:
  -h, --help            show this help message and exit

ELFWS has five subcommands: create, report, show, suppress and version.

create

Use the create subcommand to generate a suppression rule file from a given warning file.

This can be used as a starting point for a suppression file. Care should be taken as the output messages are not formatted to support regular expressions.

The arguments for the subcommand can be listed using the -h option:

$ elfws create -h
usage: elfws create [-h] [--suppression_file SUPPRESSION_FILE]
                    log_file output_suppression_file

positional arguments:
  log_file              Log file with warnings to extract
  output_suppression_file
                        Suppression file to create

optional arguments:
  -h, --help            show this help message and exit
  --suppression_file SUPPRESSION_FILE
                        Existing suppression file to filter out existing

report

Use the report subcommand to generate detailed output of suppression warnings.

The report will show the following information:

• Unsuppressed warnings
• Which suppression rules suppressed which warnings
• Unused suppression rules
• Warnings that were suppressed by multiple suppression rules
• Summary of suppression rules and warnings

The report can be used during reviews to ensure the suppressions are valid.

This command has the option argument --junit, which will output a JUnit XML file. This file can be used with continuous integration tools to check for new warnings.

The arguments for the subcommand can be listed using the -h option:

$ elfws report -h
usage: elfws report [-h] [--junit JUNIT] log_file suppression_file report_file

positional arguments:
  log_file          Log file to check for warnings
  suppression_file  YAML formatted warning suppression file
  report_file       Output report file

optional arguments:
  -h, --help        show this help message and exit
  --junit JUNIT     Generate JUnit XML file JUNIT

show

Use the show subcommand to list all the warnings in a logfile.

This can be useful when first starting out suppressing warnings and a suppression rule file does not exist.

The arguments for the subcommand can be listed using the -h option:

$ elfws show -h

usage: elfws show [-h] log_file

positional arguments:
  log_file    Log file to show warnings

optional arguments:
  -h, --help  show this help message and exit

suppress

Use the suppress subcommand to suppress warnings in a logfile.

This can be useful when creating a suppression rule file. It reports the results to the screen and only shows warnings which have not been suppressed.

This subcommand can also be used to support a continuous integration (CI) flow using the --junit option. The --junit option will create a JUnit XML file which can be read by CI tools.

The arguments for the subcommand can be listed using the -h option:

$ elfws suppress -h

usage: elfws suppress [-h] log_file suppression_file

positional arguments:
  log_file          Log file to check for warnings
  suppression_file  YAML formatted warning suppression file

optional arguments:
  -h, --help        show this help message and exit

version

Use the version subcommand to report the installed version of ELFWS.

There are no arguments for this subcommand.

$ elfws version

EDA Log File Warning Suppressor (ELFWS) version 1.0.0

Documentation

All documentation for ELFWS is hosted at read-the-docs.

Contributing

I welcome any contributions to this project. No matter how small or large.

There are several ways to contribute:

• Bug reports
• Code base improvements
• Feature requests

Please refer to the documentation hosted at read-the-docs for more details on contributing.

eda-log-file-warning-suppressor's Issues

Add options to allow rules which do not waive anything to be suppressed

Waivers that do not suppress anything will exit with a failing error code. A use case came up in which a user wants to keep a waiver even though it does not waive anything.

Consider adding an options option to a waiver and include something like do_not_fail_if_match_not_found.

The cdc_rul.log file for Questa CDC version 2023 is not being detected as a valid log file

The is_logfile() function is not detecting newer Questa CDC log files.

TypeError is raised when comment field is left blank

As the title says:

     'ID':
        - msg: Some message
          comment:
          author: jcleary

Raises a TypeError

Need to handle this gracefully.

Need to capture exceptions raised by pyyaml

If there is an exception raised by pyyaml, then elfws should output formatted text.

Add parsing of Vivado Methodology Report

Add parsing for the Methodology Report.

Add JUnit output

The --junit option has not been implemented yet.

Update cdc_log.rpt detection

The cdc_log.rpt changes based on the version of questacdc. Update the detection to be more robust.

Refresh documentation

There are references to the old name of the tool that should be updated.

This would include spelling and grammar and making the documentation easier to read.

Add section on CI support.

Tests will fail if a file is being edited.

Some editors leave a file for backup while editing. For example vim uses .swp files. This causes tests to fail as those files are being pulled in.

Filter out files which do not end in py

Multiply defined suppression rules are overwriting existing rules

In the following suppression file:

suppress:
   'ID1':
       - msg: some message
   'ID1':
       - msg: some other message

The first ID1 is dropped.

The desired behavior is they should be merged.

Mentor Precision Warning without ID not handled

Mentor Graphics Precision also has the following warning type:

Warning: bunch of text, line [0-9]*:

This is not being parsed correctly.

& in junit XML file causes Bamboo to not parse the file

See title

Misnamed vendor tool Quasta

In the documentation Quasta should be Questa.

Remove unused test files

There are files left behind by the tests which are committed. Update tests to remove the files after executing and remove the committed files.

Need a way to classify warnings as "to be looked at"

The should be a way to classify warnings as those that are low risk but need to be looked at.

This will allow the user to have a clean run, but still track down issues .

Documentation is not building

Documentation is error out.

Add checking of QuestaCDC reports

Add checking of various Questa CDC reports

Suppress table output if no warnings were found

There are several instances where the table header and footer are printed when there are no warnings to print.

I would be cleaner to only print the table header and footer only if there are warnings.

Allow for wildcarding IDs

Having the ability to wildcard IDs will allow for smaller configurations.

Add parsing of Synplify Pro log files

Add parsing of Synplify Pro log files

Exit codes

Add different exit codes based on analysis.

Need to read Xilinx Vivado log file

The logfile that is outputted from Xilinx has this identifier:

#------------------------------------------------------------
# Vivado v2018.3 (64-bit)
# SW Build
# IP Build
# Process ID:
# Current directory:
# Command line:
# Log file
# Journal file:
#------------------------------------------------------------

This is different than the runme.log files and has additional warnings in it from IP generation.

long ID's do not line up correctly

The first column does not scale with the length of the warning ID.

Add parsing of Siemens/Mentor Qlint report file

Add Xilinx Vivado support

Add Xilinx Vivado log file support.

ELFWS crashes when empty file passed for a suppression file for the report subcommand

If an empty suppression file is given for the suppression file when running a report, VSG crashes.