feat(ThirdParty): Unity unit test

[EricB-ADI]

Pull Request Template

Description

• Included 3rd party lib unity for unit testing
• Added unit test example

[EricB-ADI]

Hey @Jake-Carter , I want to integrate unity into our SDK so we can have, and offer a unit test framework. I have it working ok, but it would benefit a lot more if we can integrate it better into the build system. I updated the libs.mk to include the lib. You can run the tests on target, but it is definitely meant to be ran on the PC. Looking for some pointers or help trying to integrate this better.

[EricB-ADI]

/clang-format-run

[Jake-Carter]

Hey @Jake-Carter , I want to integrate unity into our SDK so we can have, and offer a unit test framework. I have it working ok, but it would benefit a lot more if we can integrate it better into the build system. I updated the libs.mk to include the lib. You can run the tests on target, but it is definitely meant to be ran on the PC. Looking for some pointers or help trying to integrate this better.

Sounds good, I'll take a look

[Jake-Carter]

https://github.com/ThrowTheSwitch/Unity

[Jake-Carter]

@EricB-ADI seems easy enough to integrate. Some comments/questions below. Looks like we may need to just assign some custom printing configuration macros to our printf/UART drivers

[EricB-ADI]

Just realized it got added as a submodule and none of the folders are there. Yes I did make a unity.mk.

[EricB-ADI]

This should make more sense now.

[EricB-ADI]

/clang-format-run

[EricB-ADI]

@Jake-Carter Everything is working as expected. I reran MSDKGen to update all the makefiles.

@EricB-ADI can you revert it and just update a single project? My browser crashes now when I try to view the diff

done

[sihyung-maxim]

Did you test the example in Keil and IAR (judging by the example's project files)?

If not, I'd recommend deleting those files from the example because it's still TBD how we'll handle IAR and Keil with the SDK. I don't know if we'll continue using the old setup we used to have. Code delivery and setting up a system to sync the codebase for IAR/Keil with GitHub hasn't been officially decided yet (mainly due to a lack of resources).

Also, don't forget to update the boards' examples.txt with the new example.

[sihyung-maxim]

Extra file?

[sihyung-maxim]

Removed Unity from the linter.

[Jake-Carter]

@EricB-ADI pushed my latest changes. Streamlined the integration with the host PC and added some documentation to the UG. Also slightly modified the example and options.

Of note are some updates to the unity config in 274b74f. I was seeing hard faults on the host micro from those setjmp calls on assertion failures so I disabled them.

Works well on my target micro and host machine. Have you already developed some way to check the return code of a micro's main function when it's under debug? This would be a useful addition to the documentation for developing automated hardware-in-the-loop testing with this framework.

[EricB-ADI]

Thanks for

@EricB-ADI pushed my latest changes. Streamlined the integration with the host PC and added some documentation to the UG. Also slightly modified the example and options.

Of note are some updates to the unity config in 274b74f. I was seeing hard faults on the host micro from those setjmp calls on assertion failures so I disabled them.

Works well on my target micro and host machine. Have you already developed some way to check the return code of a micro's main function when it's under debug? This would be a useful addition to the documentation for developing automated hardware-in-the-loop testing with this framework.

I have not, but I suspect we can do it by checking the register after a return. I have some pyocd automation scripts so I may take a look at that to see what happens.

[Jake-Carter]

Sounds good. I poked around r0-r3 a bit but didn't pick out a consistent pattern. I was hoping GDB would exit and pass through the return code but the micro just goes into .SPIN and GDB doesn't really support finish on the outermost frame.

Lmk if you find anything, otherwise I think we can add some documentation on parsing the serial output. OK and FAIL are consistent strings

[EricB-ADI]

It should be pretty easy to make an automation script with GDB to break at void UnityFail(...) If it doesn't break and we hit a while loop or spin then it passed. We also have a test now that looks for serial prints. So we could modify to make sure the tests are passing from the print outs