/// <summary>
/// Skips a test based on the passed condition.
/// </summary>
public PIWebAPIFactAttribute(PIWebAPITestCondition feature)
: base(PIWebAPITests.KeySetting, PIWebAPITests.KeySettingTypeCode)
{
// Return if the Skip property has been changed in the base constructor
if (!string.IsNullOrEmpty(Skip))
{
return;
}
try
{
if (PIWebAPIFixture.SkipReason == null)
{
using (var fixture = new PIWebAPIFixture())
{
// Constructor will create SkipReason collection, then dispose will clean up
}
}
Skip = PIWebAPIFixture.SkipReason[feature];
}
catch (Exception ex)
{
Skip = $"Test skipped due to the initialization error [{ex.Message}].";
}
}
public void CheckPIWebAPIHomePageTest()
{
const int E_FAIL = unchecked ((int)0x80004005);
if (string.IsNullOrEmpty(Settings.PIWebAPI))
{
Output.WriteLine($"'PIWebAPI' setting value is not set in app.config. Check if home page loads was skipped.");
}
else
{
using (var fixture = new PIWebAPIFixture())
{
try
{
Output.WriteLine($"Load PI Web API home page [{fixture.HomePageUrl}].");
var homeData = JObject.Parse(fixture.Client.DownloadString(fixture.HomePageUrl));
Assert.True(!string.IsNullOrEmpty((string)homeData["Links"]["Self"]),
"Failed to load PI Web API home page. The service may be stopped or in a bad state.");
}
catch (WebException ex)
{
if (ex.InnerException != null)
{
if (ex.InnerException.HResult == E_FAIL)
{
Output.WriteLine("Failed to load PI Web API home page. Check Kerberos delegation configuration.");
}
}
Assert.True(ex.Status != WebExceptionStatus.TrustFailure,
"Failed to load PI Web API home page because its certificate is not trusted. It is strongly " +
"recommended to use a trusted certificate, but if desired, this check can be bypassed by setting " +
"SkipCertificateValidation to True in the App.config.");
Assert.True(ex.Status == WebExceptionStatus.TrustFailure,
$"Failed to load PI Web API home page. Encountered a WebException:{Environment.NewLine}{ex.ToString()}");
}
}
}
}
/// <summary>
/// Skips a test based on the passed condition.
/// </summary>
public GenericFactAttribute(TestCondition feature, bool error)
: base(AFTests.KeySetting, AFTests.KeySettingTypeCode)
{
string afVersion = AFGlobalSettings.SDKVersion;
string piHomeDir = string.Empty;
// Return if the Skip property has been changed in the base constructor
if (!string.IsNullOrEmpty(Skip))
{
return;
}
string piHome64 = null;
string piHome32 = null;
DataLinkUtils.GetPIHOME(ref piHome64, 1);
DataLinkUtils.GetPIHOME(ref piHome32, 0);
switch (feature)
{
case TestCondition.AFCLIENTCURRENTPATCH:
Version sdkVersion = new Version(afVersion);
if (sdkVersion < _afClientCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_afClientCurrentVersionString}! Please consider upgrading! You are currently on {sdkVersion}";
}
break;
case TestCondition.AFPATCH2107:
sdkVersion = new Version(afVersion);
if (sdkVersion < new Version("2.10.7"))
{
Skip = $@"Warning! You do not have the critical patch: PI AF 2018 SP3 Patch 1 (2.10.7)! Please consider upgrading to avoid data loss! You are currently on {sdkVersion}";
}
break;
case TestCondition.AFSERVERCURRENTPATCH:
Version serverVersion = new Version(AFFixture.GetPISystemFromConfig().ServerVersion);
if (serverVersion < _afServerCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_afServerCurrentVersionString}! Please consider upgrading! You are currently on {serverVersion}";
}
break;
case TestCondition.ANALYSISCURRENTPATCH:
Version analysisVer = new Version(AFFixture.GetPISystemFromConfig().AnalysisRulePlugIns["PerformanceEquation"].Version);
if (analysisVer < _analysisCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_analysisCurrentVersionString}! Please consider upgrading! You are currently on {analysisVer}";
}
break;
case TestCondition.DATALINKCURRENTPATCH:
string afDataDLLPath = @"Excel\OSIsoft.PIDataLink.AFData.dll";
DataLinkUtils.GetPIHOME(ref piHomeDir);
Version dataLinkVersion = new Version(FileVersionInfo.GetVersionInfo(Path.Combine(piHomeDir, afDataDLLPath)).FileVersion);
if (dataLinkVersion < _dataLinkCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_dataLinkCurrentVersionString}! Please consider upgrading! You are currently on {dataLinkVersion}";
}
break;
case TestCondition.NOTIFICATIONSCURRENTPATCH:
PISystem system = AFFixture.GetPISystemFromConfig();
var configstore = new PINotificationsConfigurationStore(system);
PINotificationsWCFClientManager wcfClient = new PINotificationsWCFClientManager(configstore);
var serviceStatus = wcfClient.GetServiceStatus();
wcfClient.Dispose();
Version notificationsVersion = new Version(serviceStatus.Version);
if (notificationsVersion < _notificationsCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_notificationsCurrentVersionString}! Please consider upgrading! You are currently on {notificationsVersion}";
}
break;
case TestCondition.PIDACURRENTPATCH:
PIServer serv = new PIServers()[Settings.PIDataArchive];
serv.Connect();
Version pidaVersion = new Version(serv.ServerVersion);
if (pidaVersion < _dataArchiveCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_dataArchiveCurrentVersionString}! Please consider upgrading! You are currently on {pidaVersion}";
}
break;
case TestCondition.PISQLOLEDBCURRENTPATCH:
string sqlpath64OLEDB = Path.Combine(piHome64, @"SQL\SQL Client\OLEDB\PISQLOLEDB64.dll");
string sqlpath32OLEDB = Path.Combine(piHome32, @"SQL\SQL Client\OLEDB\PISQLOLEDB.dll");
if (File.Exists(sqlpath64OLEDB))
{
Version piSqlVersion = new Version(FileVersionInfo.GetVersionInfo(sqlpath64OLEDB).FileVersion);
if (piSqlVersion < _sqlClientOLEDBCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_sqlClientOLEDBCurrentVersionString}! Please consider upgrading! You are currently on {piSqlVersion}";
}
}
if (File.Exists(sqlpath32OLEDB))
{
Version piSqlVersion = new Version(FileVersionInfo.GetVersionInfo(sqlpath32OLEDB).FileVersion);
if (piSqlVersion < _sqlClientOLEDBCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_sqlClientOLEDBCurrentVersionString}! Please consider upgrading! You are currently on {piSqlVersion}";
}
}
break;
case TestCondition.PISQLODBCCURRENTPATCH:
string sqlpath64ODBC = Path.Combine(piHome64, @"SQL\SQL Client\ODBC\PISQLODBCB64.dll");
string sqlpath32ODBC = Path.Combine(piHome32, @"SQL\SQL Client\ODBC\PISQLODBC.dll");
if (File.Exists(sqlpath64ODBC))
{
Version piSqlVersion = new Version(FileVersionInfo.GetVersionInfo(sqlpath64ODBC).FileVersion);
if (piSqlVersion < _sqlClientODBCCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_sqlClientODBCCurrentVersionString}! Please consider upgrading! You are currently on {piSqlVersion}";
}
}
if (File.Exists(sqlpath32ODBC))
{
Version piSqlVersion = new Version(FileVersionInfo.GetVersionInfo(sqlpath32ODBC).FileVersion);
if (piSqlVersion < _sqlClientODBCCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_sqlClientODBCCurrentVersionString}! Please consider upgrading! You are currently on {piSqlVersion}";
}
}
break;
case TestCondition.PIWEBAPICURRENTPATCH:
var url = $"https://{Settings.PIWebAPI}:{443}/piwebapi/system";
WebClient client = new WebClient {
UseDefaultCredentials = true
};
AFElement elem = new AFElement();
bool disableWrites = false;
bool anonymousAuth = false;
JObject data = new JObject();
try
{
PIWebAPIFixture.GetWebApiClient(ref client, ref elem, ref disableWrites, ref anonymousAuth);
data = JObject.Parse(client.DownloadString(url));
}
catch
{
throw new InvalidOperationException($"Could not retrieve PI Web API version from server {Settings.PIWebAPI}!");
}
finally
{
client.Dispose();
}
var productVersion = (string)data["ProductVersion"];
Version piWebAPIVersion = new Version(productVersion);
if (piWebAPIVersion < _webAPICurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_webAPICurrentVersionString}! Please consider upgrading! You are currently on {piWebAPIVersion}";
}
break;
case TestCondition.RTQPCURRENTPATCH:
string connectionString = $"Provider=PISQLClient.1;Data Source={Settings.AFDatabase};Location={Settings.AFServer};Integrated Security=SSPI;OLE DB Services=-2";
using (var connection = new OleDbConnection(connectionString))
{
connection.Open();
try
{
using (var command = new OleDbCommand("SELECT Version FROM System.Diagnostics.Version WHERE Item='Query Processor'", connection))
{
string tempVersion = (string)command.ExecuteScalar();
Version rtqpVersion = new Version(tempVersion);
if (rtqpVersion < _rtqpCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_rtqpCurrentVersionString}! Please consider upgrading! You are currently on {rtqpVersion}";
}
}
}
catch (Exception)
{
Skip = $@"Warning! You do not have the latest update: {_rtqpCurrentVersionString}! Please consider upgrading!";
}
}
break;
case TestCondition.PIVISIONCURRENTPATCH:
string path = Settings.PIVisionServer;
if (path.EndsWith("/#/", StringComparison.OrdinalIgnoreCase))
{
path = path.Substring(0, path.Length - 3);
}
string visionUrl = $"{path}/Utility/permissions/read";
var visionProductVersion = string.Empty;
using (var visionClient = new WebClient {
UseDefaultCredentials = true
})
{
visionClient.Headers.Add("X-Requested-With", "XMLHttpRequest");
visionProductVersion = visionClient.DownloadString(visionUrl);
}
Version piVisionVersion = new Version();
if (!string.IsNullOrWhiteSpace(visionProductVersion))
{
piVisionVersion = new Version(visionProductVersion);
}
else
{
throw new InvalidOperationException($"Could not retrieve PI Vision version from server {Settings.PIVisionServer}!");
}
if (piVisionVersion < _visionCurrentVersion)
{
Skip = $@"Warning! You do not have the latest update: {_visionCurrentVersionString}! Please consider upgrading! You are currently on {piVisionVersion}";
}
break;
}
if (error && !string.IsNullOrEmpty(Skip))
{
throw new Exception(Skip);
}
}
