Test_SimulationOptions.cs

Go to the documentation of this file.

using System;
using AnalyzeRe;
using AnalyzeRe.Layers;
using AnalyzeRe.Metrics;
using AnalyzeReTesting.Base;
using AnalyzeReTesting.Utilities;
 
#if MSTEST
using Microsoft.VisualStudio.TestTools.UnitTesting;
#elif NUNIT
using NUnit.Framework;
using TestClass = NUnit.Framework.TestFixtureAttribute;
using TestMethod = NUnit.Framework.TestAttribute;
using TestCategory = NUnit.Framework.CategoryAttribute;
#endif
 
namespace AnalyzeReTesting.Tests.Model.DataTypes
{
    [TestClass]
    public sealed class TestSuite_SimulationOptions : BaseServerTestSuite
    {
        private const string Category = "SimulationOptions";
        
        #region Reporting Period
        private void AssertReportingPeriodMatches(SimulationOptions options, Context context)
        {
            // Check that reporting period matches within tolerance (if set)
            AssertApi.DatesAreEqual(options.reporting_period?.begin, context.reporting_period_begin);
            AssertApi.DatesAreEqual(options.reporting_period?.end, context.reporting_period_end);
        }
 
        private void TestAllMetricsResponses(SimulationOptions options)
        {
            PollingOptions simulationPolling = TestSuite_APIResourceView.SimulationPolling;
 
            if (EnvironmentSettings.RUN_OFFLINE)
                Assert.Inconclusive("RUN_OFFLINE = true");
            ILayerView<CatXL> view = Samples.LayerView_CatXL.Posted;
            // Check that each request type correctly relays the expected reporting period
            TailMetrics metrics = view.tail_metrics_blocking(1,
                new MetricsOptions(options), simulationPolling);
            AssertReportingPeriodMatches(options, metrics.context);
            WindowMetrics windowMetrics = view.window_metrics_blocking(
                ProbabilityWindow.All, new MetricsOptions(options), simulationPolling);
            AssertReportingPeriodMatches(options, windowMetrics.context);
            CoMetrics cometrics = view.co_metrics_blocking(ProbabilityWindow.All, view.ToReference(),
                new CoMetricsOptions(options), simulationPolling);
            AssertReportingPeriodMatches(options, cometrics.context);
            ExceedanceProbability exprob = view.exceedance_probability_blocking(0,
                new ExceedanceProbabilityOptions(options), simulationPolling);
            AssertReportingPeriodMatches(options, exprob.context);
            // YELT and YLT download don't have a context, so we have to trust those work too.
            // TODO: Contrive data and a reporting period to assert that they do work.
        }
 
        [TestMethod, TestCategory(Category)]
        public void Test_ReportingPeriod_BeginOnly()
        {
            TestAllMetricsResponses(new SimulationOptions(reporting_period:
                new ReportingPeriod(DateTime.UtcNow)));
        }
 
        [TestMethod, TestCategory(Category)]
        public void Test_ReportingPeriod_EndOnly()
        {
            TestAllMetricsResponses(new SimulationOptions(reporting_period:
                new ReportingPeriod(end: DateTime.UtcNow.AddDays(31))));
        }
 
        [TestMethod, TestCategory(Category)]
        public void Test_ReportingPeriod_Begin_MinDate()
        {
            TestAllMetricsResponses(new SimulationOptions(reporting_period:
                new ReportingPeriod(new DateTime(DateTime.MinValue.Ticks, DateTimeKind.Utc))));
        }
 
        [TestMethod, TestCategory(Category)]
        public void Test_ReportingPeriod_End_MaxDate()
        {
            TestAllMetricsResponses(new SimulationOptions(reporting_period:
                new ReportingPeriod(end: new DateTime(DateTime.MaxValue.Ticks, DateTimeKind.Utc))));
        }
 
        [TestMethod, TestCategory(Category)]
        public void Test_ReportingPeriod_BeginAndEnd()
        {
            TestAllMetricsResponses(new SimulationOptions(reporting_period:
                new ReportingPeriod(DateTime.UtcNow, DateTime.UtcNow.AddDays(1))));
        }
 
        [TestMethod, TestCategory(Category)]
        public void Test_ReportingPeriod_TimezoneOffsets()
        {
            DateTime now = new DateTime(DateTime.UtcNow.Ticks, DateTimeKind.Unspecified);
            TestAllMetricsResponses(new SimulationOptions(reporting_period:
                new ReportingPeriod(new DateTimeOffset(now, TimeSpan.FromHours(1)).LocalDateTime,
                new DateTimeOffset(now, TimeSpan.FromHours(-1)).LocalDateTime)));
        }
 
        [TestMethod, TestCategory(Category)]
        public void Test_ReportingPeriod_Constructor_BeginEqualsEnd()
        {
            DateTime now = DateTime.UtcNow;
            AssertApi.ExceptionThrown(() =>
                new SimulationOptions(reporting_period: new ReportingPeriod(now, now)),
                (ArgumentException ex) => Assert.AreEqual("When both a begin and end date are specified, " +
                    "the begin date must be less than end date.", ex.Message));
        }
        #endregion Reporting Period
    }
}