Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CHERRY-PICK] BaseTools/Plugin: Clarify code coverage failure message #375

Commits on Apr 26, 2023

  1. [CHERRY-PICK] BaseTools/Plugin: Clarify code coverage failure message

    HostBasedUnitTestRunner.py is a build plugin responsible for locating
    and executing host-based unit tests.
    
    Recently, commit 6bb00aa introduced support for the plugin to
    generate code coverage reports via lcov and OpenCppCoverage.
    
    The plugin has discovered unit tests by searching for executables
    with "Test" in the name for a while. However, the test coverage
    change makes assumptions about test presence when crafting the
    OpenCppCoverage command that ultimately fails with an ambiguous error
    message if no host-based unit tests are discovered (see "ERROR").
    
    ```
    SECTION - Run Host based Unit Tests
    SUBSECTION - Testing for architecture: X64
    ERROR - UnitTest Coverage: Failed to generate cobertura format xml in
            single package.
    PROGRESS - --->Test Success: Host Unit Test Compiler Plugin NOOPT
    ```
    
    This change preempts that message with a check in the plugin to
    determine if any host-based tests were discovered. If not, a message
    is printed with more guidance about how the developer should proceed
    to either (1) fix their tests so code coverage is generated as
    expected or (2) prevent the error message.
    
    New message:
    
    ```
    SECTION - Run Host based Unit Tests
    SUBSECTION - Testing for architecture: X64
    WARNING - UnitTest Coverage:
      No unit tests discovered. Test coverage will not be generated.
    
      Prevent this message by:
      1. Adding host-based unit tests to this package
      2. Ensuring tests have the word "Test" in their name
      3. Disabling HostUnitTestCompilerPlugin in the package CI YAML file
    PROGRESS - --->Test Success: Host Unit Test Compiler Plugin NOOPT
    ```
    
    Cc: Rebecca Cran <rebecca@bsdio.com>
    Cc: Liming Gao <gaoliming@byosoft.com.cn>
    Cc: Bob Feng <bob.c.feng@intel.com>
    Cc: Yuwei Chen <yuwei.chen@intel.com>
    Cc: Michael D Kinney <michael.d.kinney@intel.com>
    Cc: Sean Brogan <sean.brogan@microsoft.com>
    Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
    Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
    Reviewed-by: Rebecca Cran <rebecca@bsdio.com>
    (cherry picked from commit 3163f34)
    makubacki committed Apr 26, 2023
    Configuration menu
    Copy the full SHA
    c0e9e21 View commit details
    Browse the repository at this point in the history