[edk2-devel] another PR rejected by CI

[edk2-devel] another PR rejected by CI

[Ard Biesheuvel]

Could someone please explain to me how I can figure out why this PR
was rejected by the CI?

https://github.com/tianocore/edk2/pull/4763


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108060): https://edk2.groups.io/g/devel/message/108060
Mute This Topic: https://groups.io/mt/101015386/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] another PR rejected by CI

[Mike Maslenkin]

Hello!

https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=ms.vss-test-web.build-test-results-tab&runId=877528&resultId=100006&paneView=attachments

Uncrustify found formatting errors in IoMmuDxe/IoMmuBuffer.c
See Standard_Error_Output.log in "attachments"

It doesn't like two spaces at assignment
MapInfo->PlainTextAddress_ _= 0;

Best Regards,
Mike


On Mon, Aug 28, 2023 at 8:58 PM Ard Biesheuvel <ardb@kernel.org> wrote:
>
> Could someone please explain to me how I can figure out why this PR
> was rejected by the CI?
>
> https://github.com/tianocore/edk2/pull/4763
>
>
> 
>
>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108061): https://edk2.groups.io/g/devel/message/108061
Mute This Topic: https://groups.io/mt/101015386/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] another PR rejected by CI

[Taylor Beebe]

[-- Attachment #1: Type: text/plain, Size: 1734 bytes --]

Here's a git-patch so you can easily fix it:

---
  OvmfPkg/IoMmuDxe/IoMmuBuffer.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/OvmfPkg/IoMmuDxe/IoMmuBuffer.c b/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
index 2764c35044ac..d66763263784 100644
--- a/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
+++ b/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
@@ -434,7 +434,7 @@ IoMmuFreeBounceBuffer (
        mReservedMemBitmap,
        mReservedMemBitmap & ((UINT32)(~MapInfo->ReservedMemBitmap))
        ));
-    MapInfo->PlainTextAddress  = 0;
+    MapInfo->PlainTextAddress = 0;
      ClearReservedMemBit (MapInfo->ReservedMemBitmap);
      MapInfo->ReservedMemBitmap = 0;
    }
-- 
On 8/28/2023 11:16 AM, Mike Maslenkin wrote:
> Hello!
>
> https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=ms.vss-test-web.build-test-results-tab&runId=877528&resultId=100006&paneView=attachments
>
> Uncrustify found formatting errors in IoMmuDxe/IoMmuBuffer.c
> See Standard_Error_Output.log in "attachments"
>
> It doesn't like two spaces at assignment
> MapInfo->PlainTextAddress_ _= 0;
>
> Best Regards,
> Mike
>
>
> On Mon, Aug 28, 2023 at 8:58 PM Ard Biesheuvel<ardb@kernel.org>  wrote:
>> Could someone please explain to me how I can figure out why this PR
>> was rejected by the CI?
>>
>> https://github.com/tianocore/edk2/pull/4763
>>
>>
>>
>>
>>
>
> 
>
>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108062): https://edk2.groups.io/g/devel/message/108062
Mute This Topic: https://groups.io/mt/101015386/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-



[-- Attachment #2: Type: text/html, Size: 4121 bytes --]

Re: [edk2-devel] another PR rejected by CI

[Michael D Kinney]

Hi Ard,

I think your main question is how all developers can find the 
details of any of these types of test failures.  It is not 
obvious until you notice there is a "Tests" tab on one of the
Azure Pipelines pages.

The main interface to developers for these types of failures
is "Test" results in Azure Pipelines that allows the developer
to navigate to each test failure using web links:

For example, I see one of the failures following the links from the GitHub details into the Azure pipelines log:

PROGRESS - --Running OvmfPkg: Uncrustify Coding Standard Test NO-TARGET --
WARNING - A file header template is not specified in the config file.
WARNING - A function header template is not specified in the config file.
ERROR - Visit the following instructions to learn how to find the detailed formatting errors in Azure DevOps CI: https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-Formatting#how-to-find-uncrustify-formatting-errors-in-continuous-integration-ci
ERROR - /__w/1/s/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
ERROR - --->Test Failed: Uncrustify Coding Standard Test NO-TARGET returned 1
PROGRESS - --Running OvmfPkg: Dsc Complete Check Test NO-TARGET --
PROGRESS - --->Test Success: Dsc Complete Check Test NO-TARGET

I followed the following links to get these details, but does not show the detailed log info with the specific uncrustify issue:
https://github.com/tianocore/edk2/pull/4763
https://github.com/tianocore/edk2/pull/4763/checks?check_run_id=16279570168
https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=resultshttps://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=logs&j=ec42d809-3c3b-54a9-276c-e54a8b9aaee9&t=bd91c6c3-6d75-5ede-7b63-5767cf827334

If you go back to the results view:
https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=results

There us a "Tests" Tab:

https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=ms.vss-test-web.build-test-results-tab

And there is a link to a coding standard compliance failure:

https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=ms.vss-test-web.build-test-results-tab&runId=877528&resultId=100006&paneView=debug

Select "Attachments" tab:

https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=ms.vss-test-web.build-test-results-tab&runId=877528&resultId=100006&paneView=attachments

The select "Standard_Error_Output.log" and shows the following details:

Files with formatting errors:
 Formatting errors in IoMmuDxe/IoMmuBuffer.c
 --- /__w/1/s/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
 +++ /__w/1/s/OvmfPkg/IoMmuDxe/IoMmuBuffer.c.uncrustify_plugin
 @@ -434,7 +434,7 @@
 mReservedMemBitmap,
 mReservedMemBitmap & ((UINT32)(~MapInfo->ReservedMemBitmap))
 ));
 -    MapInfo->PlainTextAddress  = 0;
 +    MapInfo->PlainTextAddress = 0;
 ClearReservedMemBit (MapInfo->ReservedMemBitmap);
 MapInfo->ReservedMemBitmap = 0;
 }

========= 

The same information is available by downloading the build artifacts and reviewing the TestSuites.xml file:

https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=logs&j=ec42d809-3c3b-54a9-276c-e54a8b9aaee9
https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=artifacts&pathAsName=false&type=publishedArtifacts

Select "Build Logs TARGET_PLATFORMS" -> . . . -> Download artifacts

Open "TestSuites.xml" and found the following detailed info:

Found Uncrustify at /__w/1/s/.pytool/Plugin/UncrustifyCheck/mu-uncrustify-release_extdep/Linux-x86/uncrustify
 Uncrustify version: Uncrustify-c82ee034
 
 Uncrustify executed against 555 files in OvmfPkg in 3.79 seconds.
 </system-out><system-err>Files with formatting errors:
 Formatting errors in IoMmuDxe/IoMmuBuffer.c
 --- /__w/1/s/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
 +++ /__w/1/s/OvmfPkg/IoMmuDxe/IoMmuBuffer.c.uncrustify_plugin
 @@ -434,7 +434,7 @@
 mReservedMemBitmap,
 mReservedMemBitmap &amp; ((UINT32)(~MapInfo-&gt;ReservedMemBitmap))
 ));
 -    MapInfo-&gt;PlainTextAddress  = 0;
 +    MapInfo-&gt;PlainTextAddress = 0;
 ClearReservedMemBit (MapInfo-&gt;ReservedMemBitmap);
 MapInfo-&gt;ReservedMemBitmap = 0;
 }


Mike

> -----Original Message-----
> From: Ard Biesheuvel <ardb@kernel.org>
> Sent: Monday, August 28, 2023 10:58 AM
> To: Michael Kubacki <mikuback@linux.microsoft.com>; Taylor Beebe
> <t@taylorbeebe.com>; Kinney, Michael D <michael.d.kinney@intel.com>;
> Oliver Smith-Denny <osde@linux.microsoft.com>; edk2-devel-groups-io
> <devel@edk2.groups.io>
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Subject: another PR rejected by CI
> 
> Could someone please explain to me how I can figure out why this PR
> was rejected by the CI?
> 
> https://github.com/tianocore/edk2/pull/4763


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108063): https://edk2.groups.io/g/devel/message/108063
Mute This Topic: https://groups.io/mt/101015386/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/leave/12367111/7686176/1913456212/xyzzy [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] another PR rejected by CI

[Oliver Smith-Denny]

Another option, when the main pipeline page says there is an uncrustify
error is to take the cmdline it ran with and append
UNCRUSTIFY_IN_PLACE=TRUE to it. It will then auto-fixup any uncrustify
errors (which obviously should be audited afterwards). I do this to
avoid having to wade through numerous errors, especially since I
almost always take whatever the auto-format provides.

For example, for your failure, if you ran:

stuart_ci_build -c .pytool/CISettings.py -p OvmfPkg -t NO-TARGET,NOOPT 
-a IA32,X64,ARM,AARCH64,RISCV64,LOONGARCH64 TOOL_CHAIN_TAG=GCC5 
UNCRUSTIFY_IN_PLACE=TRUE

It will autofix the issue.

Oliver

On 8/28/2023 11:19 AM, Taylor Beebe wrote:
> Here's a git-patch so you can easily fix it:
> 
> ---
>   OvmfPkg/IoMmuDxe/IoMmuBuffer.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> diff --git a/OvmfPkg/IoMmuDxe/IoMmuBuffer.c b/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
> index 2764c35044ac..d66763263784 100644
> --- a/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
> +++ b/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
> @@ -434,7 +434,7 @@ IoMmuFreeBounceBuffer (
>         mReservedMemBitmap,
>         mReservedMemBitmap & ((UINT32)(~MapInfo->ReservedMemBitmap))
>         ));
> -    MapInfo->PlainTextAddress  = 0;
> +    MapInfo->PlainTextAddress = 0;
>       ClearReservedMemBit (MapInfo->ReservedMemBitmap);
>       MapInfo->ReservedMemBitmap = 0;
>     }
> -- 
> On 8/28/2023 11:16 AM, Mike Maslenkin wrote:
>> Hello!
>>
>> https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=ms.vss-test-web.build-test-results-tab&runId=877528&resultId=100006&paneView=attachments
>>
>> Uncrustify found formatting errors in IoMmuDxe/IoMmuBuffer.c
>> See Standard_Error_Output.log in "attachments"
>>
>> It doesn't like two spaces at assignment
>> MapInfo->PlainTextAddress_ _= 0;
>>
>> Best Regards,
>> Mike
>>
>>
>> On Mon, Aug 28, 2023 at 8:58 PM Ard Biesheuvel<ardb@kernel.org>  wrote:
>>> Could someone please explain to me how I can figure out why this PR
>>> was rejected by the CI?
>>>
>>> https://github.com/tianocore/edk2/pull/4763
>>>
>>>
>>>
>>>
>>>
>>
>>
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108064): https://edk2.groups.io/g/devel/message/108064
Mute This Topic: https://groups.io/mt/101015386/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] another PR rejected by CI

[Ard Biesheuvel]

On Mon, 28 Aug 2023 at 20:37, Kinney, Michael D
<michael.d.kinney@intel.com> wrote:
>
> Hi Ard,
>
> I think your main question is how all developers can find the
> details of any of these types of test failures.  It is not
> obvious until you notice there is a "Tests" tab on one of the
> Azure Pipelines pages.
>
> The main interface to developers for these types of failures
> is "Test" results in Azure Pipelines that allows the developer
> to navigate to each test failure using web links:
>
> For example, I see one of the failures following the links from the GitHub details into the Azure pipelines log:
>
> PROGRESS - --Running OvmfPkg: Uncrustify Coding Standard Test NO-TARGET --
> WARNING - A file header template is not specified in the config file.
> WARNING - A function header template is not specified in the config file.
> ERROR - Visit the following instructions to learn how to find the detailed formatting errors in Azure DevOps CI: https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-Formatting#how-to-find-uncrustify-formatting-errors-in-continuous-integration-ci
> ERROR - /__w/1/s/OvmfPkg/IoMmuDxe/IoMmuBuffer.c
> ERROR - --->Test Failed: Uncrustify Coding Standard Test NO-TARGET returned 1
> PROGRESS - --Running OvmfPkg: Dsc Complete Check Test NO-TARGET --
> PROGRESS - --->Test Success: Dsc Complete Check Test NO-TARGET
>
> I followed the following links to get these details, but does not show the detailed log info with the specific uncrustify issue:
> https://github.com/tianocore/edk2/pull/4763
> https://github.com/tianocore/edk2/pull/4763/checks?check_run_id=16279570168
> https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=resultshttps://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=logs&j=ec42d809-3c3b-54a9-276c-e54a8b9aaee9&t=bd91c6c3-6d75-5ede-7b63-5767cf827334
>
> If you go back to the results view:
> https://dev.azure.com/tianocore/edk2-ci/_build/results?buildId=100301&view=results
>

Thanks for the help

Weirdly, the 'tests' tab next to 'summary' does not always appear -
'Ubuntu GCC 5 PR' has it, but none of the other failed (sub-)tests do

Does this mean that 'Windows VS2019 PR' failed on another test? Could
someone explain how to navigate this failure and dig up what the
problem is there?


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#108065): https://edk2.groups.io/g/devel/message/108065
Mute This Topic: https://groups.io/mt/101015386/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-