Version: 1.0.8
Warning: PI System Deployment Tests should not be run on a production environment. Please read all documentation to ensure proper and secure use of these tests.
PI System Deployment Tests are a lightweight testing framework along with a set of test samples designed to serve as a starting point for assessing the latest versions of the PI System prior to deployment. Each customer has a unique PI System architecture. These sample tests are meant to provide examples customers can use to get started building a more holistic, testing setup that meets the needs of their PI System.
This GitHub repo contains the source code (xUnit tests), documentation, and a script that compiles and runs the tests.
It is expected for users to execute the xUnit test source code 'as is' and unmodified with the exception of the App.config file.
PI System Deployment Tests have been designed and tested on English operating systems.
The PI System Deployment Tests repo contains these directories:
| Directory | Contents |
|---|---|
| \scripts | Contains the Run.ps1 PowerShell script supporting routines. |
| \source | Contains a C# solution with xUnit tests. Also contains the App.config file, which you edit to point to your test PI System. |
| \xml | Contains the OSIsoftTests-Wind.xml file. This file is imported into a target PI Server to create the Wind Farm AF database and associated PI points. |
Before running the script and tests, you must perform the following prerequisite tasks:
-
Prepare your PI System and determine which PI System components to include in the testing. See Requirements for detailed instructions.
-
Set up a test client machine where tests will run. Make sure to use a Windows user account that meets the required security levels defined in Requirements.
a. Install AF Client (AF 2018 SP3 or later) on the test client machine.
b. Install PowerShell tools for the PI System on the test client machine. Both AF Client and PowerShell tools are included in the PI Server 2018 SP3 install kit.
-
Download and extract the sample-pi_core-pi_core_deployment_tests-powershell-master.zip file to the test client machine.
-
Edit the App.config file (located in the \source directory) to match your selections from step 1. This file specifies what target PI System components to test.
Note: After completing these steps, you are ready to execute the Run.ps1 script to run the tests. See Run the scripts and tests for instructions.
A segmented environment for PI System Deployment Tests is recommended in the event of potentially errant test code or malicious download (however unlikely) which could damage the test environment.
The Run.ps1 script contains all the steps required to execute the test suite. This script reads the App.config file from the source directory to determine which tests to run and where PI System components are located. The script imports the WindFarm AF database (OSIsoftTests_Wind.xml) using the AF database name, and the AF Server and PI Data Archive locations specified in the App.config file. Next, it creates PI points, downloads and installs all required assemblies (.NET development pack, NuGet, and MSBuild) if required, and compiles the test suite.
The xUnit.console runner is used to execute tests. Settings in the App.config file determine which tests run. Tests results are placed in the \testResults directory.
The Run.ps1 script executes the tests in two general steps:
- The Preliminary Checks confirm if your PI System configuration meets minimum requirements. These checks verify various things such as if the required Windows services are running, if the machines configured in the App.config file are online, and if the user running the tests has sufficient privileges.
- Executes the tests for required and any optional components as configured in the App.config file.
At the end of the script, you have the option of removing the AF database and PI points created earlier by the script.
To request a new sample, if there is a feature or capability you would like demonstrated, or if there is an existing sample you would like in your favorite language, please give us feedback at https://feedback.aveva.com under the Developer Samples category. Feedback.
If your support question or issue is related to an OSIsoft product (error message, problem with product configuration, etc.), please open a case with OSIsoft Tech Support through the myOSIsoft Customer Portal.
If your support question or issue is related to a non-modified sample (or test) or sample documentation; please email Samples@osisoft.com.
Copyright 2019-2022 OSIsoft, LLC.
PI System Deployment Tests are licensed under the Apache 2 license.
Refer to the root directory for the License.md.
For the main PI System samples page on master ReadMe
For the main OSIsoft samples page on master ReadMe