Files
Chocolatey-tools/tests/README_TESTS.md
dfrancis-adm 72a469c9b7 Initial
2019-04-25 10:55:56 -04:00

1.0 KiB

Understanding Tests

This template comes with the following files:

  • Feature.Tests.ps1 - Place tests of the features of the module within this file.
  • Help.Exceptions.txt - If there are functions you wish to exclude from the Comment Based Help tests, place their names in this file.
  • Help.Tests.ps1 - Performs tests on the Comment Based Help for public functions within the module. You shouldn't need to edit this file.
  • Project.Exceptions.txt - If there are specific PowerShell Script Analyser tests you wish to disable, place their names in this file. I recommend however to use the exclusions listed at the top of your functions.
  • Project.Tests.ps1 - Tests that your module meets all PowerShell Script Analyser tests. Also tests that the module successfully loads.
  • Unit.Tests.ps1 - This provides a basic structure for your unit tests. Best practice is to copy this file for each function/CMDLet within the module. This structure allows for the execution of the tests for a specific function/CMDLet.