<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40"> <head> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <meta name="ProgId" content="Word.Document"> <meta name="Generator" content="Microsoft Word 15"> <meta name="Originator" content="Microsoft Word 15"> <link rel="File-List" href="cid:filelist.xml@01D5B414.B2F42CF0"><link rel="Edit-Time-Data" href="cid:editdata.mso"><style></style> </head> <body lang="EN-US" link="blue" vlink="#954F72" style="tab-interval:.5in"> <div class="WordSection1"> Hi Jiewen,<o:p></o:p> <o:p> </o:p> Many of your responses are related to fuzz testing.<o:p></o:p> <o:p> </o:p> Can we focus current infrastructure on host based unit testing and minimizing the content to support that testing type.<o:p></o:p> <o:p> </o:p> Then, add a new subdirectory below Test in the future to support fuzz testing. This way, lib instances can be tuned to the test infrastructure/subsystem in use. Trying to make one version of the host libs for multiple test methodologies it making is more complex and hander to maintain.<o:p></o:p> <o:p> </o:p> Thanks,<o:p></o:p> <o:p> </o:p> Mike<o:p></o:p> <o:p> </o:p> <div style="border:none;border-left:solid blue 1.5pt;padding:0in 0in 0in 4.0pt"> <div> <div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in"> From: Yao, Jiewen <jiewen.yao@intel.com> Sent: Saturday, December 14, 2019 4:38 PM To: devel@edk2.groups.io; bret.barkelew@microsoft.com; Andrew Fish <afish@apple.com>; Kinney, Michael D <michael.d.kinney@intel.com> Cc: rfc@edk2.groups.io Subject: RE: [EXTERNAL] Re: [edk2-devel] EDK2 Host-Based Unit Test RFC (Now with docs!)<o:p></o:p> </div> </div> <o:p> </o:p> Answer the question 5,6,7,8, which are related to HBFA.<o:p></o:p> <o:p> </o:p> For other MSFT unit test, I don’t have strong opinion. I am OK with that.<o:p></o:p> <o:p> </o:p> Thank you<o:p></o:p> Yao Jiewen<o:p></o:p> <o:p> </o:p> <div> <div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in"> <a name="_____replyseparator"></a>From: <a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a> <<a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a>> On Behalf Of Bret Barkelew via Groups.Io Sent: Saturday, December 14, 2019 8:47 AM To: <a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a>; Andrew Fish <<a href="mailto:afish@apple.com">afish@apple.com</a>>; Kinney, Michael D <<a href="mailto:michael.d.kinney@intel.com">michael.d.kinney@intel.com</a>> Cc: <a href="mailto:rfc@edk2.groups.io">rfc@edk2.groups.io</a> Subject: Re: [EXTERNAL] Re: [edk2-devel] EDK2 Host-Based Unit Test RFC (Now with docs!)<o:p></o:p> </div> </div> <o:p> </o:p> Mike,<o:p></o:p> <o:p> </o:p> I think I’ve gotten all the feedback here and all the action items from our call. The current branch should be good to go, minus the couple of things that Intel was going to look into.<o:p></o:p> <o:p> </o:p> Thanks!<o:p></o:p> <o:p> </o:p> - Bret<o:p></o:p> <o:p> </o:p> <div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in"> From: <a href="mailto:Bret.Barkelew@microsoft.com">Bret Barkelew</a> Sent: Friday, December 6, 2019 2:21 PM To: <a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a>; <a href="mailto:afish@apple.com"> Andrew Fish</a>; <a href="mailto:michael.d.kinney@intel.com">Kinney, Michael D</a> Cc: <a href="mailto:rfc@edk2.groups.io">rfc@edk2.groups.io</a> Subject: RE: [EXTERNAL] Re: [edk2-devel] EDK2 Host-Based Unit Test RFC (Now with docs!)<o:p></o:p> </div> <o:p> </o:p> <ol style="margin-top:0in" start="1" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> I see that MdePkg adds a dependency on UnitTestPkg. This makes UnitTestPkg the root package when building and running host based unit tests. This makes sense, but good to highlight that all packages that use host based tests will introduce a new package dependency on UnitTestPkg. <o:p></o:p></li></ol> <ol style="margin-top:0in" start="1" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Since the dependency only applies to unit tests, can we update the DependencyCheck plugin to support listing dependencies for FW components separate from dependencies for unit tests?<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Can move. Capability is there, but mistakenly added to the wrong section.<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="2" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> I see UnitTestPkg declares 6 new lib classes. Are all 6 classes intended to be used directly from a unit test case? If some of these are only intended to be used from the framework inside the UnitTestPkg can we make them private?<o:p></o:p></li></ol> <ol style="margin-top:0in" start="2" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Because there are different instances in multiple places (and conceivably more in the future), we don’t see how we could make them private.<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="3" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> In the MdePkg, I see a new top level directory called ‘HostLibrary’. Since these lib instances are only used from a host based test, can they be moved into the ‘Test’ directory?<o:p></o:p></li></ol> <ol style="margin-top:0in" start="3" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Can move.<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="4" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> MdePkg/MdePkgTest.dsc. <o:p> </o:p></li></ol> <ol style="margin-top:0in" start="4" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Can this DSC file be moved into the ‘Test’ directory? <o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>Yes<o:p></o:p> <ol style="margin-top:0in" start="4" type="1"> <ol style="margin-top:0in" start="2" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> I see this DSC file only supports VS today. How much work is it to add GCC support?<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>Don’t know. This is an item on our list, but lower priority and not a blocker.<o:p></o:p> <ol style="margin-top:0in" start="5" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> MdePkg/HostLibrary/BaseLibHost <o:p></o:p></li></ol> <ol style="margin-top:0in" start="5" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Why are there 2 INFs. One with ASM and one without ASM? Can we just use the one with ASM and assume NASM is installed?<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> I see the purpose of this lib instance is to call the <o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> SetJump()/LongJump(). So these implementations always work? It looks like it assumes BASE_LIBRARY_JUMP_BUFFER is identical to the host OS user mode application setjmp()/longjmp() state.<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Why are DRx and CRx registers emulated? I would think and code that depends on read/writing these registers would not be compatible with host based testing. Can we change to ASSERT (FALSE)?<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> PatchInstructionX86() – I suspect this will not work in a host based environment because it is self modifying code. Should it be ASSERT (FALSE)?<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Libraries were taken directly from the Intel work in HBFA. They worked so we kept them. We’re just as interested in the answers to these questions as you are.<o:p></o:p></li></ol> </ol> [Jiewen] Here is the answer:<o:p></o:p> Some tools requires source build, such AFL-CC or KLEE to get the result or optimization. They do analysis besides compiling. These tools only work on C-language. That why we need non-asm build.<o:p></o:p> Some test case need access CRx/DRx just as the pre-condition and post-condition, such as MTRR test. We cannot use ASSERT.<o:p></o:p> Generally, a big problem of current based lib is that it mixes the hardware register access (such as CR/DR, CPUIR, MSR, mode switch) into a common software lib (such as linked list, math, string, checksum). I hope we can refactory the based lib to separate the hardware access part, such as a BaseRegAccessLib, similar to IoLib, PciLib.<o:p></o:p> Agree on PatchInstructionX86(). We should use ASSERT(). If we encounter a case that requires this function, we consider how to make it work later.<o:p></o:p> <o:p> </o:p> <ol style="margin-top:0in" start="6" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> MdePkg/HostLibrary/DebugLibHost <o:p></o:p></li></ol> <ol style="margin-top:0in" start="6" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> What is ‘#ifndef TEST_WITH_KLEE’<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> What is the ‘PatchFormat()’ function? It is always disabled with if (0).<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Are the PCDs to set the debug message levels disabled on purpose? (DebugPrintEnabled(), DebugPrintLevelEnabled(), DebugCodeEnabled())<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Libraries were taken directly from the Intel work in HBFA. They worked so we kept them. We’re just as interested in the answers to these questions as you are.<o:p></o:p></li></ol> </ol> <o:p> </o:p> [Jiewen] Here is the answer:<o:p></o:p> This is special optimization for KLEE – a symbolic execution tool. We hope to reduce the unnecessary branch. Or the KELL might not resolve the function.<o:p></o:p> PatchFormat() is an old function. Deadcode can be removed now.<o:p></o:p> In the beginning, PCD is not supported. And we don’t find a use case to control PCD in such detail level. To simplify thing, we just don’t use it. An on/off control (via HOST_DEBUG_MESSAGE) is good enough. If there is real use case coming up, we can see how to enable it.<o:p></o:p> <o:p> </o:p> <o:p> </o:p> <ol style="margin-top:0in" start="7" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> MdePkg/HostLibrary/BaseMemoryLibHost <o:p></o:p></li></ol> <ol style="margin-top:0in" start="7" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Why can’t we use MdePkg/Library/BaseMemoryLib/BaseMemoryLib/inf instead and reduce the number of host specific lib instances? <o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Libraries were taken directly from the Intel work in HBFA. They worked so we kept them. We’re just as interested in the answers to these questions as you are.<o:p></o:p></li></ol> </ol> [Jiewen] Here is the answer:<o:p></o:p> This is special optimization for fuzzing tool. If we use standard C lib, the compiler knows it and don’t insert branch analysis. If we use our own implementation, the compiler has no idea, and try to do analysis. That is unnecessary.<o:p></o:p> <o:p> </o:p> <o:p> </o:p> <ol style="margin-top:0in" start="8" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> MdePkg/HostLibrary/MemoryAllocationLibHost <o:p></o:p></li></ol> <ol style="margin-top:0in" start="8" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Why is are memcpy(), assert(), memset() used in this lib? I would expect this lib instance to match the UefiMemoryAllocationLib with the only the use of malloc() and free() to replace the UEFI Boot Services calls. <o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Libraries were taken directly from the Intel work in HBFA. They worked so we kept them. We’re just as interested in the answers to these questions as you are.<o:p></o:p></li></ol> </ol> [Jiewen] Here is the answer:<o:p></o:p> Similar to 7, using standard-C function can reduce the unnecessary analysis for analysis tool.<o:p></o:p> <o:p> </o:p> <ol style="margin-top:0in" start="9" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> Host library instance naming conventions. <o:p></o:p></li></ol> <ol style="margin-top:0in" start="9" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> The current naming convention uses the environment as a prefix(e.g. Pei, Smm, Uefi) and the services the lib instance uses as a post fix. Would it make more sense to use ‘Host’ as a prefix instead of a postfix in the lib instance names?<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> I don’t know if there’s a 1:1 relationship with these. For some library classes (that you might have host versions of), the class itself is the PeiSomethingLib, and the host version would be the PeiSomethingLibHost. No?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="10" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> Unicode vs ASCII strings <o:p> </o:p></li></ol> <ol style="margin-top:0in" start="10" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> I see InitUnitTestFramework(), CreateUnitTestSuite(), and AddTestCase() all take Unicode strings for the labels. I also see extra code to convert gEfiCallerBaseName from ASCII to Unicode to use it as a short name of a test framework. I think it would be simpler if the parameters to these APIs were ASCII and the framework can convert to Unicode if needed.<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> No strong feelings, but we already have a bunch of tests written this way. Since the UnitTestLib is an abstraction that works as well in Shell as in the Host, going with Unicode strings seemed to match the art for Shell apps (since the framework was written for Shell first).<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="11" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> Will InitUnitTestFramework() and CreateUnitTestSuite() always be called in pairs? If so, can we combine these to a single API? <o:p></o:p></li></ol> <ol style="margin-top:0in" start="11" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> I see the SafeIntLib example create a single framework and multiple test suites. Perhaps we can have a single CreateUnitTestSuite() API where Framework is an IN/OUT and if it is passed in as NULL, the Framework handle is created.<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>It’s not always in pairs. You would only have a single framework init, but could have multiple suites.<o:p></o:p> <ol style="margin-top:0in" start="11" type="1"> <ol style="margin-top:0in" start="2" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> I see a pattern where the CreateUnitTestSuite() ‘Package’ parameter is used as a prefix to every call to AddTestCase() in the ‘ClassName’ parameter. Can we simplify AddTestCase() so it only need to pass in the name of the unit test case, and the framework can append Package and the unit test case name?<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>Right now, our tests just coincidentally share similar names with the packages, but we don’t feel this is axiomatic and don’t want to force this naming on others, who may be trying to bolt into other reporting structures.<o:p></o:p> <ol style="margin-top:0in" start="12" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> I see the use of the ‘Fw’ variable as a shorthand for ‘Framework’. Can we use something other than ‘Fw’. It may be confused with ‘Firmware’. <o:p></o:p></li></ol> <ol style="margin-top:0in" start="12" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> No real arguments. Wouldn’t fight a find-replace, but it’ll just be a bunch of touches as we commit.<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="13" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> UnitTestPkg/Include/UnitTestTypes.h <o:p></o:p></li></ol> <ol style="margin-top:0in" start="13" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> I see several hard coded string lengths. Since this runs in a host environment and strings can always be allocated, can the hard coded lengths be removed? Update the structs to use pointers to strings instead of string arrays, and the framework can manage alloc() and free()?<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>Given that this framework is designed to be nimble enough to work in PEI and SMM and other constrictive environments, we wanted to keep fixed sizing.<o:p></o:p> <ol style="margin-top:0in" start="13" type="1"> <ol style="margin-top:0in" start="2" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> How are Fingerprints used? The idea of using as hash as a unique identifier is a good idea. How is the hash calculated? What unit test code artifacts are used so developers know what parameters must be unique? Can we just decide to use a specific hash algorithm/size and the structure can be a pointer to an allocated buffer instead of a fixed size array to make it easy to change the algorithm/size in the future?<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>Fingerprints are unique IDs to make sure that serialize/unserialized state matches the tests upon re-entry. I’m not married to MD5, but it needs to be predictably unique, and carried with the framework. I would not want to make any requirements on CryptoLib, since these aren’t crypto-strong.<o:p></o:p> <ol style="margin-top:0in" start="13" type="1"> <ol style="margin-top:0in" start="3" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Update all the strings to be ASCII? See Unicode vs ASCII above.<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>Ideally not, unless there’s a strong use case.<o:p></o:p> <ol style="margin-top:0in" start="13" type="1"> <ol style="margin-top:0in" start="4" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> UNIT_TEST_SAVE_TEST – The last field is a variable sized array, so it can be a formal field.<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>Not opposed, but don’t really want to make the change myself. Is there a style guide that this is breaking?<o:p></o:p> <ol style="margin-top:0in" start="13" type="1"> <ol style="margin-top:0in" start="5" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> UNIT_TEST_SAVE_CONTEXT - – The last field is a variable sized array, so it can be a formal field.<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> UNIT_TEST_SAVE_HEADER – Can the last 3 fields be changed to pointers and be formal fields?<o:p></o:p></li><li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Do the structures really need to be packed? Specially with the changes suggested above? Is the intent to potentially share data stored on disk between different host execution environments that may have different width architectures?<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>That’s an interesting point. Could you draw up your suggestion and submit a PR?<o:p></o:p> <ol style="margin-top:0in" start="14" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> UnitTestPkg – UnitTestLib.h <o:p></o:p></li></ol> <ol style="margin-top:0in" start="14" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Can you provide more context for the APIs SaveFrameworkState(), SaveFrameworkStateAndQuit(), SaveFrameworkStateAndReboot(), SetFrameworkBootNextDevice(). I do not see any Load() functions, so how would a set of tests be resumed? If these do not apply to host based tests, should these be split out to a different lib class?<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>I’ll improve the documentation around these functions. I will acknowledge, however, that this is an interface that I expect to evolve as we figure out what kinds of tests the community wants support for “out of the box”. If we want to easily enable tests around – for example – ExitBootServices, we will likely want to tweak this going forward to its simplest form. The version we have here was sufficient to enable the test cases that we’ve currently written.<o:p></o:p> <ol style="margin-top:0in" start="15" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> UnitTestPkg/Library/UnitTestLib <o:p></o:p></li></ol> <ol style="margin-top:0in" start="15" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> I see an implementation of MD5. We should not do our own. We should use an approved implementation such as OpenSSL.<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>Happy to discuss another implementation, but this is not crypto-strong. It’s just for uniqueness. A sufficiently long CRC would probably work, too.<o:p></o:p> <ol style="margin-top:0in" start="16" type="1"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level1 lfo1"> UnitTestPkg/Library/UnitTestTerminationLibTbd <o:p></o:p></li></ol> <ol style="margin-top:0in" start="16" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="MsoListParagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l17 level2 lfo1"> Do we really need this lib instance now?<o:p></o:p></li></ol> </ol> <p class="MsoListParagraph" style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-1.5in;mso-text-indent-alt:-9.0pt;mso-list:l17 level3 lfo1"> <![if !supportLists]> i. <![endif]>This is here so that we can figure out what this should look like for a host. Host obviously wouldn’t reset, but could conceivably quit. Or maybe that doesn’t make any sense for a host.<o:p></o:p> <o:p> </o:p> <o:p> </o:p> <o:p> </o:p> - Bret<o:p></o:p> <o:p> </o:p> <img border="0" width="555" height="2" id="Horizontal_x0020_Line_x0020_1" src="cid:image002.png@01D5B414.B2CBE470"><o:p></o:p> <div id="divRplyFwdMsg"> From: <a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a> <<a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a>> on behalf of Bret Barkelew via Groups.Io <<a href="mailto:bret.barkelew=microsoft.com@groups.io">bret.barkelew=microsoft.com@groups.io</a>> Sent: Wednesday, December 4, 2019 10:24:21 AM To: Andrew Fish <<a href="mailto:afish@apple.com">afish@apple.com</a>>; <a href="mailto:devel@edk2.groups.io"> devel@edk2.groups.io</a> <<a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a>>; Kinney, Michael D <<a href="mailto:michael.d.kinney@intel.com">michael.d.kinney@intel.com</a>> Cc: <a href="mailto:rfc@edk2.groups.io">rfc@edk2.groups.io</a> <<a href="mailto:rfc@edk2.groups.io">rfc@edk2.groups.io</a>> Subject: Re: [EXTERNAL] Re: [edk2-devel] EDK2 Host-Based Unit Test RFC (Now with docs!) <o:p></o:p> <div> <o:p></o:p> </div> </div> <div> <div> Andrew,<o:p></o:p> I agree with your points.<o:p></o:p> <o:p></o:p> Mike,<o:p></o:p> You’ve got a lot more there. Let me take a look and update the draft. I’ll ping back ASAP.<o:p></o:p> <o:p></o:p> - Bret<o:p></o:p> <o:p></o:p> <div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in"> From: <a href="mailto:afish@apple.com">Andrew Fish</a> Sent: Wednesday, December 4, 2019 9:50 AM To: <a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a>; <a href="mailto:michael.d.kinney@intel.com"> Kinney, Michael D</a> Cc: <a href="mailto:Bret.Barkelew@microsoft.com">Bret Barkelew</a>; <a href="mailto:rfc@edk2.groups.io"> rfc@edk2.groups.io</a> Subject: [EXTERNAL] Re: [edk2-devel] EDK2 Host-Based Unit Test RFC (Now with docs!)<o:p></o:p> </div> <o:p></o:p> Mike, <o:p></o:p> <div> <o:p></o:p> </div> <div> I like and agree with your comments.<o:p></o:p> </div> <div> <o:p></o:p> </div> <div> On the UnitTestPkg(s) dependency issue I think it would make sense to move as much as possible into the *Pkg/Test/ ( *Pkg/HostLibrary, MdePkg/MdePkgTest.dsc, etc.) directory structure. It looks like for implementation specific tests we skip the Test directory and drop the UnitTest or FuzzTest directly into modules directory. Maybe we should follow the same pattern as *Pkg/Test and have a Test directory? This will help minimize the number of "reserved" directories we need for managing the testing. Have a standardized directory structure will make it easier to differentiate the code from tests while doing `git grep` or other forms of code spelunking. <o:p></o:p> </div> <div> <o:p></o:p> </div> <div> A Host-Based Unit Test for a Library makes sense as you can link directly against the library and test it. A Host-Based Unit Test for Protocol/PPI/GUID [1] seems a little more complex. It is easy enough to write tests for the interfaces but what APIs do you call to get access to the protocol? <o:p></o:p> </div> <div> <o:p></o:p> </div> <div> Per our conversation at the Stewards meeting I think make sense to try to roll out the testing of libraries as the 1st phase. The mocking required for drivers could get quite complex and let us not get bogged down in all that to get something working. <o:p></o:p> </div> <div> <o:p></o:p> </div> <div> [1] *Pkg/Test/UnitTest/[Library|Protocol|Ppi|Guid] <o:p></o:p> </div> <div> <o:p></o:p> </div> <div> Thanks,<o:p></o:p> </div> <div> <o:p></o:p> </div> <div> Andrew Fish<o:p></o:p> </div> <div> <o:p></o:p> <div> <o:p> </o:p> <blockquote style="margin-top:5.0pt;margin-bottom:5.0pt"> <div> On Dec 2, 2019, at 3:12 PM, Michael D Kinney <<a href="mailto:michael.d.kinney@intel.com">michael.d.kinney@intel.com</a>> wrote:<o:p></o:p> </div> <o:p></o:p> <div> <div> Hi Bret,<o:p></o:p> </div> <div> <o:p></o:p> </div> <div> Thanks for posting this content. Host based unit testing is a very valuable addition to the CI checks.<o:p></o:p> </div> <div> <o:p></o:p> </div> <div> I have the following comments:<o:p></o:p> </div> <div> <o:p></o:p> </div> <ol style="margin-top:0in" start="1" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l13 level1 lfo2;tab-stops:list .5in"> I see that MdePkg adds a dependency on UnitTestPkg. This makes UnitTestPkg the root package when building and running host based unit tests. This makes sense, but good to highlight that all packages that use host based tests will introduce a new package dependency on UnitTestPkg. <o:p></o:p></li></ol> <ol style="margin-top:0in" start="1" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l9 level2 lfo3;tab-stops:list 1.0in"> Since the dependency only applies to unit tests, can we update the DependencyCheck plugin to support listing dependencies for FW components separate from dependencies for unit tests?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="2" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l19 level1 lfo4;tab-stops:list .5in"> I see UnitTestPkg declares 6 new lib classes. Are all 6 classes intended to be used directly from a unit test case? If some of these are only intended to be used from the framework inside the UnitTestPkg can we make them private?<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l19 level1 lfo4;tab-stops:list .5in"> In the MdePkg, I see a new top level directory called ‘HostLibrary’. Since these lib instances are only used from a host based test, can they be moved into the ‘Test’ directory?<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l19 level1 lfo4;tab-stops:list .5in"> MdePkg/MdePkgTest.dsc. <o:p></o:p></li></ol> <ol style="margin-top:0in" start="4" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l26 level2 lfo5;tab-stops:list 1.0in"> Can this DSC file be moved into the ‘Test’ directory? <o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l26 level2 lfo5;tab-stops:list 1.0in"> I see this DSC file only supports VS today. How much work is it to add GCC support?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="5" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l4 level1 lfo6;tab-stops:list .5in"> MdePkg/HostLibrary/BaseLibHost <o:p></o:p></li></ol> <ol style="margin-top:0in" start="5" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l1 level2 lfo7;tab-stops:list 1.0in"> Why are there 2 INFs. One with ASM and one without ASM? Can we just use the one with ASM and assume NASM is installed?<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l1 level2 lfo7;tab-stops:list 1.0in"> I see the purpose of this lib instance is to call the<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l1 level2 lfo7;tab-stops:list 1.0in"> SetJump()/LongJump(). So these implementations always work? It looks like it assumes BASE_LIBRARY_JUMP_BUFFER is identical to the host OS user mode applicationsetjmp()/longjmp() state.<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l1 level2 lfo7;tab-stops:list 1.0in"> Why are DRx and CRx registers emulated? I would think and code that depends on read/writing these registers would not be compatible with host based testing. Can we change to ASSERT (FALSE)?<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l1 level2 lfo7;tab-stops:list 1.0in"> PatchInstructionX86() – I suspect this will not work in a host based environment because it is self modifying code. Should it be ASSERT (FALSE)?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="6" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l12 level1 lfo8;tab-stops:list .5in"> MdePkg/HostLibrary/DebugLibHost <o:p></o:p></li></ol> <ol style="margin-top:0in" start="6" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l7 level2 lfo9;tab-stops:list 1.0in"> What is ‘#ifndef TEST_WITH_KLEE’<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l7 level2 lfo9;tab-stops:list 1.0in"> What is the ‘PatchFormat()’ function? It is always disabled with if (0).<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l7 level2 lfo9;tab-stops:list 1.0in"> Are the PCDs to set the debug message levels disabled on purpose? (DebugPrintEnabled(), DebugPrintLevelEnabled(), DebugCodeEnabled())<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="7" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l24 level1 lfo10;tab-stops:list .5in"> MdePkg/HostLibrary/BaseMemoryLibHost <o:p></o:p></li></ol> <ol style="margin-top:0in" start="7" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l6 level2 lfo11;tab-stops:list 1.0in"> Why can’t we use MdePkg/Library/BaseMemoryLib/BaseMemoryLib/inf instead and reduce the number of host specific lib instances?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="8" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l18 level1 lfo12;tab-stops:list .5in"> MdePkg/HostLibrary/MemoryAllocationLibHost <o:p></o:p></li></ol> <ol style="margin-top:0in" start="8" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l25 level2 lfo13;tab-stops:list 1.0in"> Why is are memcpy(), assert(), memset() used in this lib? I would expect this lib instance to match the UefiMemoryAllocationLib with the only the use of malloc() and free() to replace the UEFI Boot Services calls.<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="9" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l20 level1 lfo14;tab-stops:list .5in"> Host library instance naming conventions. <o:p></o:p></li></ol> <ol style="margin-top:0in" start="9" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l11 level2 lfo15;tab-stops:list 1.0in"> The current naming convention uses the environment as a prefix(e.g. Pei, Smm, Uefi) and the services the lib instance uses as a post fix. Would it make more sense to use ‘Host’ as a prefix instead of a postfix in the lib instance names?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="10" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l14 level1 lfo16;tab-stops:list .5in"> Unicode vs ASCII strings <o:p> </o:p></li></ol> <ol style="margin-top:0in" start="10" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l22 level2 lfo17;tab-stops:list 1.0in"> I see InitUnitTestFramework(), CreateUnitTestSuite(), and AddTestCase() all take Unicode strings for the labels. I also see extra code to convert gEfiCallerBaseName from ASCII to Unicode to use it as a short name of a test framework. I think it would be simpler if the parameters to these APIs were ASCII and the framework can convert to Unicode if needed.<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="11" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l3 level1 lfo18;tab-stops:list .5in"> Will InitUnitTestFramework() and CreateUnitTestSuite() always be called in pairs? If so, can we combine these to a single API? <o:p></o:p></li></ol> <ol style="margin-top:0in" start="11" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l0 level2 lfo19;tab-stops:list 1.0in"> I see the SafeIntLib example create a single framework and multiple test suites. Perhaps we can have a single CreateUnitTestSuite() API where Framework is an IN/OUT and if it is passed in as NULL, the Framework handle is created.<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l0 level2 lfo19;tab-stops:list 1.0in"> I see a pattern where the CreateUnitTestSuite() ‘Package’ parameter is used as a prefix to every call to AddTestCase() in the ‘ClassName’ parameter. Can we simplify AddTestCase() so it only need to pass in the name of the unit test case, and the framework can append Package and the unit test case name?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="12" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l15 level1 lfo20;tab-stops:list .5in"> I see the use of the ‘Fw’ variable as a shorthand for ‘Framework’. Can we use something other than ‘Fw’. It may be confused with ‘Firmware’. <o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l15 level1 lfo20;tab-stops:list .5in"> UnitTestPkg/Include/UnitTestTypes.h <o:p></o:p></li></ol> <ol style="margin-top:0in" start="13" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l8 level2 lfo21;tab-stops:list 1.0in"> I see several hard coded string lengths. Since this runs in a host environment and strings can always be allocated, can the hard coded lengths be removed? Update the structs to use pointers to strings instead of string arrays, and the framework can manage alloc() and free()?<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l8 level2 lfo21;tab-stops:list 1.0in"> How are Fingerprints used? The idea of using as hash as a unique identifier is a good idea. How is the hash calculated? What unit test code artifacts are used so developers know what parameters must be unique? Can we just decide to use a specific hash algorithm/size and the structure can be a pointer to an allocated buffer instead of a fixed size array to make it easy to change the algorithm/size in the future?<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l8 level2 lfo21;tab-stops:list 1.0in"> Update all the strings to be ASCII? See Unicode vs ASCII above.<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l8 level2 lfo21;tab-stops:list 1.0in"> UNIT_TEST_SAVE_TEST – The last field is a variable sized array, so it can be a formal field.<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l8 level2 lfo21;tab-stops:list 1.0in"> UNIT_TEST_SAVE_CONTEXT - – The last field is a variable sized array, so it can be a formal field.<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l8 level2 lfo21;tab-stops:list 1.0in"> UNIT_TEST_SAVE_HEADER – Can the last 3 fields be changed to pointers and be formal fields?<o:p></o:p></li><li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l8 level2 lfo21;tab-stops:list 1.0in"> Do the structures really need to be packed? Specially with the changes suggested above? Is the intent to potentially share data stored on disk between different host execution environments that may have different width architectures?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="14" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l2 level1 lfo22;tab-stops:list .5in"> UnitTestPkg – UnitTestLib.h <o:p></o:p></li></ol> <ol style="margin-top:0in" start="14" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l16 level2 lfo23;tab-stops:list 1.0in"> Can you provide more context for the APIs SaveFrameworkState(), SaveFrameworkStateAndQuit(), SaveFrameworkStateAndReboot(), SetFrameworkBootNextDevice(). I do not see any Load() functions, so how would a set of tests be resumed? If these do not apply to host based tests, should these be split out to a different lib class?<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="15" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l5 level1 lfo24;tab-stops:list .5in"> UnitTestPkg/Library/UnitTestLib <o:p></o:p></li></ol> <ol style="margin-top:0in" start="15" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l10 level2 lfo25;tab-stops:list 1.0in"> I see an implementation of MD5. We should not do our own. We should use an approved implementation such as OpenSSL.<o:p></o:p></li></ol> </ol> <ol style="margin-top:0in" start="16" type="1"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l23 level1 lfo26;tab-stops:list .5in"> UnitTestPkg/Library/UnitTestTerminationLibTbd <o:p></o:p></li></ol> <ol style="margin-top:0in" start="16" type="1"> <ol style="margin-top:0in" start="1" type="a"> <li class="xmsolistparagraph" style="margin-top:0in;margin-bottom:0in;margin-bottom:.0001pt;mso-list:l21 level2 lfo27;tab-stops:list 1.0in"> Do we really need this lib instance now?<o:p></o:p></li></ol> </ol> <div> <o:p></o:p> </div> <div> Thanks,<o:p></o:p> </div> <div> <o:p></o:p> </div> <div> Mike<o:p></o:p> </div> <div> <o:p></o:p> </div> <div> <div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in"> <div> From: <a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a> <<a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a>> On Behalf Of Bret Barkelew via Groups.Io Sent: Thursday, November 21, 2019 11:39 PM To: <a href="mailto:devel@edk2.groups.io">devel@edk2.groups.io</a> Subject: [edk2-devel] EDK2 Host-Based Unit Test RFC (Now with docs!)<o:p></o:p> </div> </div> </div> <div> <o:p></o:p> </div> Now that CI has landed in edk2/master, we'd like to get the basic framework for unittesting staged as well. Target intercept date would be immediately after the 2019/11 stabilization, so we wanted to go ahead and get comments now. The host unittest framework consists of five primary pieces: - The test library (Cmocka) - Support libraries (Found in UnitTestPkg) - The test support plugins (HostUnitTestComilerPlugin, HostUnitTestDxeCompleteCheck, HostBasedUnitTestRunner) - The configuration in the package-based *.ci.yaml file and package-based Test.dsc - The tests themselves We have a demo branch set up at: <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fcorthon%2Fedk2-staging%2Ftree%2Fedk2-host-test_v2&data=02%7C01%7Cbret.barkelew%40microsoft.com%7C6eac9932f3f640dd65ac08d778e731e3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637110806683189828&sdata=JQ%2BoWxlEBOK2sH55cRAPVa3OpAxTsm6eHcdbWSo9CVo%3D&reserved=0">https://github.com/corthon/edk2-staging/tree/edk2-host-test_v2</a> We also have a demo build pipeline at: <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdev.azure.com%2Ftianocore%2Fedk2-ci-play%2F_build%3FdefinitionId%3D36%26_a%3Dsummary&data=02%7C01%7Cbret.barkelew%40microsoft.com%7C6eac9932f3f640dd65ac08d778e731e3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637110806683189828&sdata=wBwn1ehjyTmYNKVSvlEZSXK5qyeu4EPAL7FzdYntnt4%3D&reserved=0">https://dev.azure.com/tianocore/edk2-ci-play/_build?definitionId=36&_a=summary</a> The current demo branch contains a single test in MdePkg for SafeIntLib (module file MdePkg\Test\UnitTest\Library\BaseSafeIntLib\TestBaseSafeIntLib.inf). This test is automatically detected by the HostUnitTestComilerPlugin and run by the HostBasedUnitTestRunner as part of the CI process. A few notes about the current demo: 1) The demo currently only works on Windows build chains, but there's no reason to believe that it can't work equally well on Linux build chains, and are happy to work with anyone to get it there. 2) The demo currently has four failing conditions that can be seen towards the end of MdePkg "Build and Test" log file for this build: <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdev.azure.com%2Ftianocore%2Fedk2-ci-play%2F_build%2Fresults%3FbuildId%3D2590&data=02%7C01%7Cbret.barkelew%40microsoft.com%7C6eac9932f3f640dd65ac08d778e731e3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637110806683199782&sdata=1zd2oq8zRZUn3%2FUiGDuJZEZ5M0srtc2bqoa0%2BLbZB3s%3D&reserved=0">https://dev.azure.com/tianocore/edk2-ci-play/_build/results?buildId=2813</a> "WARNING - Test SafeInt16ToChar8 - Status d:\a\1\s\MdePkg\Test\UnitTest\Library\BaseSafeIntLib\TestBaseSafeIntLib.c:302: error: Failure! WARNING - TestBaseSafeIntLib.exe Test Failed WARNING - Test SafeInt32ToChar8 - Status d:\a\1\s\MdePkg\Test\UnitTest\Library\BaseSafeIntLib\TestBaseSafeIntLib.c:638: error: Failure! WARNING - TestBaseSafeIntLib.exe Test Failed WARNING - Test SafeIntnToChar8 - Status d:\a\1\s\MdePkg\Test\UnitTest\Library\BaseSafeIntLib\TestBaseSafeIntLib.c:1051: error: Failure! WARNING - TestBaseSafeIntLib.exe Test Failed WARNING - Test SafeInt64ToChar8 - Status d:\a\1\s\MdePkg\Test\UnitTest\Library\BaseSafeIntLib\TestBaseSafeIntLib.c:1456: error: Failure!" These failures seem to be legitimate and further work should be done by the community to decide whether the test case is correct or the library is correct, but one of them needs to change. 3) Current demo pulls in test collateral from a fork of the edk2-test repo. This repo is currently *very* heavy due to the history of the UEFI SCT project and the number of binaries that it pulls down. It's possible that we (the community) need to select a better place for this code to live. Maybe in edk2 primary (though it's not explicitly firmware code, so it seems unnecessary). Maybe in a new edk2-test2 repo or something like that.<o:p></o:p> There’s an RFC doc here: <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fcorthon%2Fedk2-staging%2Fblob%2Fedk2-host-test_v2%2FReadme-RFC.md&data=02%7C01%7Cbret.barkelew%40microsoft.com%7C6eac9932f3f640dd65ac08d778e731e3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637110806683199782&sdata=1nq1mHjsbSZj4IQM5RBwSrvaQxO5cmDlTvf7VYNDV%2FA%3D&reserved=0">https://github.com/corthon/edk2-staging/blob/edk2-host-test_v2/Readme-RFC.md</a><o:p></o:p> And a usage guide here: <a href="https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fcorthon%2Fedk2-staging%2Fblob%2Fedk2-host-test_v2%2FUnitTestPkg%2FReadMe.md&data=02%7C01%7Cbret.barkelew%40microsoft.com%7C6eac9932f3f640dd65ac08d778e731e3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C637110806683209750&sdata=0jRQ2Rzr9PWSYJ1YDs7l2aFS3PfAnTbTousYYe8IWTw%3D&reserved=0">https://github.com/corthon/edk2-staging/blob/edk2-host-test_v2/UnitTestPkg/ReadMe.md</a><o:p></o:p> Once again, would love to get this into EDK2 master after stabilization, and most of this has previously been shopped around in other discussion threads. This is just where the rubber meets the road and is the minimal subset of code that needs to land for folks to start contributing unittests against the core libraries that can be run as part of any CI pass. Thanks! - Bret<o:p></o:p> </div> </blockquote> </div> </div> <o:p></o:p> <o:p></o:p> </div> <div> <o:p> </o:p> </div> </div> <div> </o:p> </div> </div> </div> </body> </html> <div width="1" style="color:white;clear:both">_._,_._,_</div> <hr> Groups.io Links: You receive all messages sent to this group. <a target="_blank" href="https://edk2.groups.io/g/devel/message/52261">View/Reply Online (#52261)</a> | | <a target="_blank" href="https://groups.io/mt/67560953/1813853">Mute This Topic</a> | <a href="https://edk2.groups.io/g/devel/post">New Topic</a> <a href="https://edk2.groups.io/g/devel/editsub/1813853">Your Subscription</a> | <a href="mailto:devel+owner@edk2.groups.io">Contact Group Owner</a> | <a href="https://edk2.groups.io/g/devel/unsub">Unsubscribe</a> [edk2-devel-archive@redhat.com] <div width="1" style="color:white;clear:both">_._,_._,_</div>