Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PowerShell/Operation-Validation-Framework
https://github.com/PowerShell/Operation-Validation-Framework
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/PowerShell/Operation-Validation-Framework
- Owner: PowerShell
- License: mit
- Archived: true
- Created: 2015-11-05T19:31:53.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-05-18T06:45:31.000Z (over 5 years ago)
- Last Synced: 2024-09-28T21:05:47.309Z (about 2 months ago)
- Language: PowerShell
- Size: 128 KB
- Stars: 225
- Watchers: 46
- Forks: 32
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - PowerShell/Operation-Validation-Framework - (PowerShell)
README
# Operation-Validation-Framework
| Azure Pipelines | AppVeyor | PS Gallery | License
|-----------------|----------|------------|---------|
[![Azure Pipelines Build Status][azure-pipeline-badge]][azure-pipeline-build] | [![AppVeyor Build Status][appveyor-badge]][appveyor-build] | [![PowerShell Gallery][psgallery-badge]][psgallery] | [![License][license-badge]][license]
A set of tools for executing validation of the operation of a system.
It provides a way to organize and execute Pester tests which are written
to validate operation (rather than limited feature tests)
Modules which include a Diagnostics directory are inspected for
Pester tests in either the "Simple" or "Comprehensive" directories.
If files are found in those directories, they will be inspected to determine
whether they are Pester tests. If Pester tests are found, the
test names in those files will be returned.
The module structure required is as follows:
* ModuleBase\
* Diagnostics\
* Simple *simple tests are held in this location (e.g., ping, serviceendpoint checks)*
* Comprehensive *comprehensive scenario tests should be placed here*
It supplies two cmdlets:
```
PS# get-help *operationvalidation
Name Category Synopsis
---- -------- --------
Get-OperationValidation Function Retrieve the operational tests from modules
Invoke-OperationValidation Function Invoke the operational tests from modules
```
## Examples
```
PS> Get-OperationValidation -ModuleName C:\temp\modules\AddNumbers
Type: Simple
File: addnum.tests.ps1
FilePath: C:\temp\modules\AddNumbers\Diagnostics\Simple\addnum.tests.ps1
Name:
Add-Em
Subtract em
Add-Numbers
Type: Comprehensive
File: Comp.Adding.Tests.ps1
FilePath: C:\temp\modules\AddNumbers\Diagnostics\Comprehensive\Comp.Adding.Tests.ps1
Name:
Comprehensive Adding Tests
Comprehensive Subtracting Tests
Comprehensive Examples
PS> Invoke-OperationValidation -IncludePesterOutput
Describing Simple Test Suite
[+] first Operational test 20ms
[+] second Operational test 19ms
[+] third Operational test 9ms
Tests completed in 48ms
Passed: 3 Failed: 0 Skipped: 0 Pending: 0
Describing Scenario targeted tests
Context The RemoteAccess service
[+] The service is running 37ms
Context The Firewall Rules
[+] A rule for TCP port 3389 is enabled 1.19s
[+] A rule for UDP port 3389 is enabled 11ms
Tests completed in 1.24s
Passed: 3 Failed: 0 Skipped: 0 Pending: 0
Module: OperationValidation
Result Name
------- --------
Passed Simple Test Suite::first Operational test
Passed Simple Test Suite::second Operational test
Passed Simple Test Suite::third Operational test
Passed Scenario targeted tests:The RemoteAccess service:The service is running
Passed Scenario targeted tests:The Firewall Rules:A rule for TCP port 3389 is enabled
Passed Scenario targeted tests:The Firewall Rules:A rule for UDP port 3389 is enabled
```
[azure-pipeline-badge]: https://dev.azure.com/devblackops/Operation-Validation-Framework/_apis/build/status/PowerShell.Operation-Validation-Framework?branchName=master
[azure-pipeline-build]: https://dev.azure.com/devblackops/Operation-Validation-Framework/_build/latest?definitionId=4&branchName=master
[appveyor-badge]: https://ci.appveyor.com/api/projects/status/rvbve3ajjtn4m0n2?svg=true
[appveyor-build]: https://ci.appveyor.com/project/devblackops/operation-validation-framework-a635v
[psgallery-badge]: https://img.shields.io/powershellgallery/dt/operationvalidation.svg
[psgallery]: https://www.powershellgallery.com/packages/operationvalidation
[license-badge]: https://img.shields.io/github/license/powerShell/operation-validation-framework.svg
[license]: https://raw.githubusercontent.com/PowerShell/Operation-Validation-Framework/master/LICENSE