[MetricsAdvisor] Added tests for some Data Feed CRUD operations (Non-Live, Create, Get) (Azure#17721)

Author: kinelski

sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/DisposableDataFeed.cs

@@ -0,0 +1,62 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Threading.Tasks;
+using Azure.AI.MetricsAdvisor.Administration;
+using Azure.AI.MetricsAdvisor.Models;
+using NUnit.Framework;
+
+namespace Azure.AI.MetricsAdvisor.Tests
+{
+    /// <summary>
+    /// Represents a <see cref="DataFeed"/> that has been created for testing purposes. In order to
+    /// create a new instance of this class, the <see cref="CreateDataFeedAsync"/> static method must
+    /// be invoked. The created data feed will be deleted upon disposal.
+    /// </summary>
+    public class DisposableDataFeed : IAsyncDisposable
+    {
+        /// <summary>
+        /// The client to use for deleting the data feed upon disposal.
+        /// </summary>
+        private readonly MetricsAdvisorAdministrationClient _adminClient;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DisposableDataFeed"/> class.
+        /// </summary>
+        /// <param name="adminClient">The client to use for deleting the data feed upon disposal.</param>
+        /// <param name="id">The identifier of the data feed this instance is associated with.</param>
+        private DisposableDataFeed(MetricsAdvisorAdministrationClient adminClient, string id)
+        {
+            _adminClient = adminClient;
+            Id = id;
+        }
+
+        /// <summary>
+        /// The identifier of the data feed this instance is associated with.
+        /// </summary>
+        public string Id { get; }
+
+        /// <summary>
+        /// Creates a data feed using the specified <see cref="MetricsAdvisorAdministrationClient"/>.
+        /// A <see cref="DisposableDataFeed"/> instance is returned, from which the ID of the created
+        /// data feed can be obtained. Upon disposal, the associated data feed will be deleted.
+        /// </summary>
+        /// <param name="adminClient">The client to use for creating and for deleting the data feed.</param>
+        /// <param name="hook">Specifies how the created <see cref="DataFeed"/> should be configured.</param>
+        /// <returns>A <see cref="DisposableDataFeed"/> instance from which the ID of the created data feed can be obtained.</returns>
+        public static async Task<DisposableDataFeed> CreateDataFeedAsync(MetricsAdvisorAdministrationClient adminClient, DataFeed dataFeed)
+        {
+            string dataFeedId = await adminClient.CreateDataFeedAsync(dataFeed);
+
+            Assert.That(dataFeedId, Is.Not.Null.And.Not.Empty);
+
+            return new DisposableDataFeed(adminClient, dataFeedId);
+        }
+
+        /// <summary>
+        /// Deletes the data feed this instance is associated with.
+        /// </summary>
+        public async ValueTask DisposeAsync() => await _adminClient.DeleteDataFeedAsync(Id);
+    }
+}

sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/MetricsAdvisorAdministrationClient/DataFeedLiveTests.cs

@@ -0,0 +1,165 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using Azure.AI.MetricsAdvisor.Administration;
+using Azure.AI.MetricsAdvisor.Models;
+using Azure.Core.TestFramework;
+using NUnit.Framework;
+
+namespace Azure.AI.MetricsAdvisor.Tests
+{
+    public class DataFeedTests : ClientTestBase
+    {
+        public DataFeedTests(bool isAsync) : base(isAsync)
+        {
+        }
+
+        private string FakeGuid => "00000000-0000-0000-0000-000000000000";
+
+        [Test]
+        public void CreateDataFeedValidatesArguments()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            Assert.That(() => adminClient.CreateDataFeedAsync(null), Throws.InstanceOf<ArgumentNullException>());
+
+            Assert.That(() => adminClient.CreateDataFeed(null), Throws.InstanceOf<ArgumentNullException>());
+        }
+
+        [Test]
+        public void CreateDataFeedRespectsTheCancellationToken()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            var dataSource = new AzureTableDataFeedSource("connectionString", "table", "query");
+            var granularity = new DataFeedGranularity(DataFeedGranularityType.Daily);
+            var schema = new DataFeedSchema(new List<DataFeedMetric>() { new DataFeedMetric("metricName") });
+            var ingestionSettings = new DataFeedIngestionSettings(DateTimeOffset.UtcNow);
+            var dataFeed = new DataFeed("dataFeedName", dataSource, granularity, schema, ingestionSettings);
+
+            using var cancellationSource = new CancellationTokenSource();
+            cancellationSource.Cancel();
+
+            Assert.That(() => adminClient.CreateDataFeedAsync(dataFeed, cancellationSource.Token), Throws.InstanceOf<OperationCanceledException>());
+            Assert.That(() => adminClient.CreateDataFeed(dataFeed, cancellationSource.Token), Throws.InstanceOf<OperationCanceledException>());
+        }
+
+        [Test]
+        public void UpdateDataFeedValidatesArguments()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            var dataSource = new AzureTableDataFeedSource("connectionString", "table", "query");
+            var granularity = new DataFeedGranularity(DataFeedGranularityType.Daily);
+            var schema = new DataFeedSchema(new List<DataFeedMetric>() { new DataFeedMetric("metricName") });
+            var ingestionSettings = new DataFeedIngestionSettings(DateTimeOffset.UtcNow);
+            var dataFeed = new DataFeed("dataFeedName", dataSource, granularity, schema, ingestionSettings);
+
+            Assert.That(() => adminClient.UpdateDataFeedAsync(null, dataFeed), Throws.InstanceOf<ArgumentNullException>());
+            Assert.That(() => adminClient.UpdateDataFeedAsync("", dataFeed), Throws.InstanceOf<ArgumentException>());
+            Assert.That(() => adminClient.UpdateDataFeedAsync("dataFeedId", dataFeed), Throws.InstanceOf<ArgumentException>().With.InnerException.TypeOf(typeof(FormatException)));
+            Assert.That(() => adminClient.UpdateDataFeedAsync(FakeGuid, null), Throws.InstanceOf<ArgumentNullException>());
+
+            Assert.That(() => adminClient.UpdateDataFeed(null, dataFeed), Throws.InstanceOf<ArgumentNullException>());
+            Assert.That(() => adminClient.UpdateDataFeed("", dataFeed), Throws.InstanceOf<ArgumentException>());
+            Assert.That(() => adminClient.UpdateDataFeed("dataFeedId", dataFeed), Throws.InstanceOf<ArgumentException>().With.InnerException.TypeOf(typeof(FormatException)));
+            Assert.That(() => adminClient.UpdateDataFeed(FakeGuid, null), Throws.InstanceOf<ArgumentNullException>());
+        }
+
+        [Test]
+        public void UpdateDataFeedRespectsTheCancellationToken()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            var dataSource = new AzureTableDataFeedSource("connectionString", "table", "query");
+            var granularity = new DataFeedGranularity(DataFeedGranularityType.Daily);
+            var schema = new DataFeedSchema(new List<DataFeedMetric>() { new DataFeedMetric("metricName") });
+            var ingestionSettings = new DataFeedIngestionSettings(DateTimeOffset.UtcNow);
+            var dataFeed = new DataFeed("dataFeedName", dataSource, granularity, schema, ingestionSettings);
+
+            using var cancellationSource = new CancellationTokenSource();
+            cancellationSource.Cancel();
+
+            Assert.That(() => adminClient.UpdateDataFeedAsync(FakeGuid, dataFeed, cancellationSource.Token), Throws.InstanceOf<OperationCanceledException>());
+            Assert.That(() => adminClient.UpdateDataFeed(FakeGuid, dataFeed, cancellationSource.Token), Throws.InstanceOf<OperationCanceledException>());
+        }
+
+        [Test]
+        public void GetDataFeedValidatesArguments()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            Assert.That(() => adminClient.GetDataFeedAsync(null), Throws.InstanceOf<ArgumentNullException>());
+            Assert.That(() => adminClient.GetDataFeedAsync(""), Throws.InstanceOf<ArgumentException>());
+            Assert.That(() => adminClient.GetDataFeedAsync("dataFeedId"), Throws.InstanceOf<ArgumentException>().With.InnerException.TypeOf(typeof(FormatException)));
+
+            Assert.That(() => adminClient.GetDataFeed(null), Throws.InstanceOf<ArgumentNullException>());
+            Assert.That(() => adminClient.GetDataFeed(""), Throws.InstanceOf<ArgumentException>());
+            Assert.That(() => adminClient.GetDataFeed("dataFeedId"), Throws.InstanceOf<ArgumentException>().With.InnerException.TypeOf(typeof(FormatException)));
+        }
+
+        [Test]
+        public void GetDataFeedRespectsTheCancellationToken()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            using var cancellationSource = new CancellationTokenSource();
+            cancellationSource.Cancel();
+
+            Assert.That(() => adminClient.GetDataFeedAsync(FakeGuid, cancellationSource.Token), Throws.InstanceOf<OperationCanceledException>());
+            Assert.That(() => adminClient.GetDataFeed(FakeGuid, cancellationSource.Token), Throws.InstanceOf<OperationCanceledException>());
+        }
+
+        [Test]
+        public void GetDataFeedsRespectsTheCancellationToken()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            using var cancellationSource = new CancellationTokenSource();
+            cancellationSource.Cancel();
+
+            IAsyncEnumerator<DataFeed> asyncEnumerator = adminClient.GetDataFeedsAsync(cancellationToken: cancellationSource.Token).GetAsyncEnumerator();
+            Assert.That(async () => await asyncEnumerator.MoveNextAsync(), Throws.InstanceOf<OperationCanceledException>());
+
+            IEnumerator<DataFeed> enumerator = adminClient.GetDataFeeds(cancellationToken: cancellationSource.Token).GetEnumerator();
+            Assert.That(() => enumerator.MoveNext(), Throws.InstanceOf<OperationCanceledException>());
+        }
+
+        [Test]
+        public void DeleteDataFeedValidatesArguments()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            Assert.That(() => adminClient.DeleteDataFeedAsync(null), Throws.InstanceOf<ArgumentNullException>());
+            Assert.That(() => adminClient.DeleteDataFeedAsync(""), Throws.InstanceOf<ArgumentException>());
+            Assert.That(() => adminClient.DeleteDataFeedAsync("dataFeedId"), Throws.InstanceOf<ArgumentException>().With.InnerException.TypeOf(typeof(FormatException)));
+
+            Assert.That(() => adminClient.DeleteDataFeed(null), Throws.InstanceOf<ArgumentNullException>());
+            Assert.That(() => adminClient.DeleteDataFeed(""), Throws.InstanceOf<ArgumentException>());
+            Assert.That(() => adminClient.DeleteDataFeed("dataFeedId"), Throws.InstanceOf<ArgumentException>().With.InnerException.TypeOf(typeof(FormatException)));
+        }
+
+        [Test]
+        public void DeleteDataFeedRespectsTheCancellationToken()
+        {
+            MetricsAdvisorAdministrationClient adminClient = GetMetricsAdvisorAdministrationClient();
+
+            using var cancellationSource = new CancellationTokenSource();
+            cancellationSource.Cancel();
+
+            Assert.That(() => adminClient.DeleteDataFeedAsync(FakeGuid, cancellationSource.Token), Throws.InstanceOf<OperationCanceledException>());
+            Assert.That(() => adminClient.DeleteDataFeed(FakeGuid, cancellationSource.Token), Throws.InstanceOf<OperationCanceledException>());
+        }
+
+        private MetricsAdvisorAdministrationClient GetMetricsAdvisorAdministrationClient()
+        {
+            var fakeEndpoint = new Uri("http://notreal.azure.com");
+            var fakeCredential = new MetricsAdvisorKeyCredential("fakeSubscriptionKey", "fakeApiKey");
+
+            return new MetricsAdvisorAdministrationClient(fakeEndpoint, fakeCredential);
+        }
+    }
+}

sdk/metricsadvisor/Azure.AI.MetricsAdvisor/tests/MetricsAdvisorAdministrationClient/DataFeedTests.cs

@@ -25,34 +25,6 @@ public async Task GetDataFeeds()
             Assert.That(feeds, Is.Not.Empty);
         }
 
-        [RecordedTest]
-        public async Task GetDataFeed()
-        {
-            var adminClient = GetMetricsAdvisorAdministrationClient();
-
-            List<DataFeed> feeds = await adminClient.GetDataFeedsAsync().ToEnumerableAsync().ConfigureAwait(false);
-
-            Assert.That(feeds, Is.Not.Empty);
-
-            foreach (DataFeed feed in feeds)
-            {
-                DataFeed feedResult = await adminClient.GetDataFeedAsync(feed.Id);
-
-                Assert.That(feedResult.CreatedTime, Is.EqualTo(feed.CreatedTime));
-                Assert.That(feedResult.Granularity.GranularityType, Is.EqualTo(feed.Granularity.GranularityType));
-                Assert.That(feedResult.Granularity.CustomGranularityValue, Is.EqualTo(feed.Granularity.CustomGranularityValue));
-                Assert.That(feedResult.Id, Is.EqualTo(feed.Id));
-                Assert.That(feedResult.IngestionSettings.DataSourceRequestConcurrency, Is.EqualTo(feed.IngestionSettings.DataSourceRequestConcurrency));
-                Assert.That(feedResult.IsAdministrator, Is.EqualTo(feed.IsAdministrator));
-                Assert.That(feedResult.MetricIds, Is.EqualTo(feed.MetricIds));
-                Assert.That(feedResult.Name, Is.EqualTo(feed.Name));
-                Assert.That(feedResult.Administrators, Is.EquivalentTo(feed.Administrators));
-                Assert.That(feedResult.Schema.DimensionColumns.Count, Is.EqualTo(feed.Schema.DimensionColumns.Count));
-                Assert.That(feedResult.SourceType, Is.EqualTo(feed.SourceType));
-                Assert.That(feedResult.Status, Is.EqualTo(feed.Status));
-            }
-        }
-
         [RecordedTest]
         public async Task CreateAndUpdateBlobDataFeed()
         {