Add Particular.Obsoletes (#1221)

* Add Particular.Obsoletes and remove Fody

* Fix obsolete attribute on obsoletes file

* Fix obsolete attributes for migration topology

* Move the constants for the obsolete messages to their own class

* Add pragmas when needed

* Add Obsolete attribute when needed.

* Tweaks

* Suppress warnings in tests

* Update APIApprovals

* Update approval test that had typo in message

* Stop using custom PreObsoleteAttribute

---------

Co-authored-by: Brandon Ording <[email protected]>

Author: tamararivera

src/AcceptanceTests/When_loading_from_options.cs

@@ -8,7 +8,7 @@
     using Azure.Messaging.ServiceBus.Administration;
     using NServiceBus.AcceptanceTests.EndpointTemplates;
     using NUnit.Framework;
-    using Conventions = NServiceBus.AcceptanceTesting.Customization.Conventions;
+    using Conventions = AcceptanceTesting.Customization.Conventions;
 
     public class When_loading_from_options
     {
@@ -64,16 +64,21 @@ await Scenario.Define<Context>()
                     {
                         var transport = c.ConfigureTransport<AzureServiceBusTransport>();
                         // doing a deliberate roundtrip to ensure that the options are correctly serialized and deserialized
+#pragma warning disable CS0618 // Type or member is obsolete
                         var serializedOptions = JsonSerializer.Serialize(new MigrationTopologyOptions
+#pragma warning restore CS0618 // Type or member is obsolete
                         {
                             QueueNameToSubscriptionNameMap = { { Conventions.EndpointNamingConvention(typeof(Publisher)), TopicName } },
                             SubscribedEventToRuleNameMap = { { typeof(Event).FullName, typeof(Event).FullName.Shorten() } },
                             TopicToPublishTo = TopicName,
                             TopicToSubscribeOn = TopicName,
                             EventsToMigrateMap = [typeof(Event).FullName]
                         }, TopologyOptionsSerializationContext.Default.TopologyOptions);
+
                         var options = JsonSerializer.Deserialize(serializedOptions, TopologyOptionsSerializationContext.Default.TopologyOptions);
+#pragma warning disable CS0618 // Type or member is obsolete
                         var topology = (MigrationTopology)TopicTopology.FromOptions(options);
+#pragma warning restore CS0618 // Type or member is obsolete
                         transport.Topology = topology;
                     });
                     b.When((session, c) => session.Publish(new Event()));

src/MigrationAcceptanceTests/ConfigureEndpointAzureServiceBusTransport.cs

@@ -19,7 +19,9 @@ public Task Configure(string endpointName, EndpointConfiguration configuration,
             throw new InvalidOperationException("envvar AzureServiceBus_ConnectionString not set");
         }
 
+#pragma warning disable CS0618 // Type or member is obsolete
         var topology = TopicTopology.MigrateFromSingleDefaultTopic();
+#pragma warning restore CS0618 // Type or member is obsolete
         topology.OverrideSubscriptionNameFor(endpointName, endpointName.Shorten());
 
         foreach (var eventType in publisherMetadata.Publishers.SelectMany(p => p.Events))

src/MigrationAcceptanceTests/Migration/When_migrating.cs

@@ -3,8 +3,8 @@
     using System;
     using System.Threading.Tasks;
     using AcceptanceTesting;
-    using Azure.Messaging.ServiceBus.Administration;
     using Azure.Messaging.ServiceBus;
+    using Azure.Messaging.ServiceBus.Administration;
     using EndpointTemplates;
     using NUnit.Framework;
     using Transport.AzureServiceBus.AcceptanceTests;
@@ -38,7 +38,9 @@ public async Task Should_not_lose_any_events()
                 {
                     b.CustomConfig(c =>
                     {
+#pragma warning disable CS0618 // Type or member is obsolete
                         var topology = TopicTopology.MigrateFromNamedSingleTopic(bundleTopicName);
+#pragma warning restore CS0618 // Type or member is obsolete
                         topology.EventToMigrate<MyEvent>();
 
                         c.ConfigureTransport<AzureServiceBusTransport>().Topology = topology;
@@ -49,7 +51,9 @@ public async Task Should_not_lose_any_events()
                 {
                     b.CustomConfig(c =>
                     {
+#pragma warning disable CS0618 // Type or member is obsolete
                         var topology = TopicTopology.MigrateFromNamedSingleTopic(bundleTopicName);
+#pragma warning restore CS0618 // Type or member is obsolete
                         topology.EventToMigrate<MyEvent>(ruleNameOverride: typeof(MyEvent).FullName.Shorten());
 
                         c.ConfigureTransport<AzureServiceBusTransport>().Topology = topology;
@@ -69,7 +73,9 @@ public async Task Should_not_lose_any_events()
                 {
                     b.CustomConfig(c =>
                     {
+#pragma warning disable CS0618 // Type or member is obsolete
                         var topology = TopicTopology.MigrateFromNamedSingleTopic(bundleTopicName);
+#pragma warning restore CS0618 // Type or member is obsolete
                         topology.EventToMigrate<MyEvent>();
 
                         c.ConfigureTransport<AzureServiceBusTransport>().Topology = topology;

src/MigrationAcceptanceTests/Receiving/When_publishing_from_different_topics.cs

@@ -75,7 +75,9 @@ public PublisherOnTopicA() =>
                 EndpointSetup<DefaultPublisher>(b =>
                 {
                     var transport = b.ConfigureTransport<AzureServiceBusTransport>();
+#pragma warning disable CS0618 // Type or member is obsolete
                     var topology = TopicTopology.MigrateFromNamedSingleTopic("bundle-a");
+#pragma warning restore CS0618 // Type or member is obsolete
                     topology.EventToMigrate<EventFromTopicA>(ruleNameOverride: typeof(EventFromTopicA).FullName.Shorten());
                     topology.EventToMigrate<EventFromTopicB>(ruleNameOverride: typeof(EventFromTopicB).FullName.Shorten());
                     topology.EventToMigrate<EventFromTopicC>(ruleNameOverride: typeof(EventFromTopicC).FullName.Shorten());
@@ -119,7 +121,9 @@ public SubscriberOnTopicB()
                     =>
                 {
                     var transport = b.ConfigureTransport<AzureServiceBusTransport>();
+#pragma warning disable CS0618 // Type or member is obsolete
                     var topology = TopicTopology.MigrateFromTopicHierarchy("bundle-a", "bundle-b");
+#pragma warning restore CS0618 // Type or member is obsolete
                     topology.EventToMigrate<EventFromTopicA>(ruleNameOverride: typeof(EventFromTopicA).FullName.Shorten());
                     topology.EventToMigrate<EventFromTopicB>(ruleNameOverride: typeof(EventFromTopicB).FullName.Shorten());
                     transport.Topology = topology;
@@ -143,7 +147,9 @@ public SubscriberOnTopicC()
                     =>
                 {
                     var transport = b.ConfigureTransport<AzureServiceBusTransport>();
+#pragma warning disable CS0618 // Type or member is obsolete
                     var topology = TopicTopology.MigrateFromTopicHierarchy("bundle-a", "bundle-c");
+#pragma warning restore CS0618 // Type or member is obsolete
                     topology.EventToMigrate<EventFromTopicA>(ruleNameOverride: typeof(EventFromTopicA).FullName.Shorten());
                     topology.EventToMigrate<EventFromTopicC>(ruleNameOverride: typeof(EventFromTopicC).FullName.Shorten());
                     transport.Topology = topology;

src/MigrationAcceptanceTests/Receiving/When_publishing_sendonly_and_subscribing_on_different_topics.cs

@@ -75,7 +75,9 @@ public SendOnlyPublisherOnTopicA() =>
                 EndpointSetup<DefaultPublisher>(b =>
                 {
                     var transport = b.ConfigureTransport<AzureServiceBusTransport>();
+#pragma warning disable CS0618 // Type or member is obsolete
                     MigrationTopology topology = TopicTopology.MigrateFromNamedSingleTopic("bundle-a");
+#pragma warning restore CS0618 // Type or member is obsolete
                     topology.EventToMigrate<MyEvent>();
                     transport.Topology = topology;
                     b.SendOnly();
@@ -89,7 +91,9 @@ public SubscriberOnTopicB()
                     =>
                 {
                     var transport = b.ConfigureTransport<AzureServiceBusTransport>();
+#pragma warning disable CS0618 // Type or member is obsolete
                     MigrationTopology topology = TopicTopology.MigrateFromTopicHierarchy("bundle-a", "bundle-b");
+#pragma warning restore CS0618 // Type or member is obsolete
                     string endpointName = Conventions.EndpointNamingConvention(typeof(SubscriberOnTopicB));
                     topology.OverrideSubscriptionNameFor(endpointName, endpointName.Shorten());
                     topology.EventToMigrate<MyEvent>(ruleNameOverride: typeof(MyEvent).FullName.Shorten());
@@ -114,7 +118,9 @@ public SubscriberOnTopicC()
                     =>
                 {
                     var transport = b.ConfigureTransport<AzureServiceBusTransport>();
+#pragma warning disable CS0618 // Type or member is obsolete
                     MigrationTopology topology = TopicTopology.MigrateFromTopicHierarchy("bundle-a", "bundle-c");
+#pragma warning restore CS0618 // Type or member is obsolete
                     string endpointName = Conventions.EndpointNamingConvention(typeof(SubscriberOnTopicC));
                     topology.OverrideSubscriptionNameFor(endpointName, endpointName.Shorten());
                     topology.EventToMigrate<MyEvent>(ruleNameOverride: typeof(MyEvent).FullName.Shorten());

src/Tests/ApprovalFiles/APIApprovals.Approve.approved.txt

@@ -14,8 +14,8 @@ namespace NServiceBus
         public int? PrefetchCount { get; set; }
         public int PrefetchMultiplier { get; set; }
         public Azure.Messaging.ServiceBus.ServiceBusRetryOptions? RetryPolicyOptions { get; set; }
-        [System.Obsolete("The transport no longer supports sending the transport encoding header. The membe" +
-            "r currently throws a NotImplementedException. Will be removed in version 7.0.0.", true)]
+        [System.Obsolete("The transport no longer supports sending the transport encoding header. Will be r" +
+            "emoved in version 7.0.0.", true)]
         public bool SendTransportEncodingHeader { get; set; }
         public System.TimeSpan TimeToWaitBeforeTriggeringCircuitBreaker { get; set; }
         [System.Diagnostics.CodeAnalysis.MemberNotNull("topology")]
@@ -35,8 +35,8 @@ namespace NServiceBus
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> MaxAutoLockRenewalDuration(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions, System.TimeSpan maximumAutoLockRenewalDuration) { }
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> PrefetchCount(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions, int prefetchCount) { }
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> PrefetchMultiplier(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions, int prefetchMultiplier) { }
-        [System.Obsolete("The transport no longer supports sending the transport encoding header. The membe" +
-            "r currently throws a NotImplementedException. Will be removed in version 7.0.0.", true)]
+        [System.Obsolete("The transport no longer supports sending the transport encoding header. Will be r" +
+            "emoved in version 7.0.0.", true)]
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> SendTransportEncodingHeader(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions) { }
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> TimeToWaitBeforeTriggeringCircuitBreaker(this NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> transportExtensions, System.TimeSpan timeToWait) { }
         public static NServiceBus.TransportExtensions<NServiceBus.AzureServiceBusTransport> UseTransport<TTransport>(this NServiceBus.EndpointConfiguration endpointConfiguration, string connectionString, NServiceBus.TopicTopology topology)

src/Tests/ApprovalFiles/MigrationTopologyTests.Should_self_validate_consistency.approved.txt

@@ -1 +1 @@
-EventsToMigrateMap: TopicToPublishTo, PublishedEventToTopicsMap: The topic to publish 'TopicToPublishTo' for 'NServiceBus.Transport.AzureServiceBus.Tests.MigrationTopologyTests+MyEvent' cannot be the sames as the topic to publish to 'TopicToPublishTo' for the migration topology.; TopicToSubscribeOn, SubscribedEventToTopicsMap: The topic to subscribe 'TopicToSubscribeOn' for 'NServiceBus.Transport.AzureServiceBus.Tests.MigrationTopologyTests+MyEvent' cannot be the sames as the topic to subscribe to 'TopicToSubscribeOn' for the migration topology.; SubscribedEventToTopicsMap: Event 'NServiceBus.Transport.AzureServiceBus.Tests.MigrationTopologyTests+MyEventMappedTwice' is in the migration map and in the subscribed event to topics map. An event type cannot be marked for migration and mapped to a topic at the same time.
+EventsToMigrateMap: TopicToPublishTo, PublishedEventToTopicsMap: The topic to publish 'TopicToPublishTo' for 'NServiceBus.Transport.AzureServiceBus.Tests.MigrationTopologyTests+MyEvent' cannot be the same as the topic to publish to 'TopicToPublishTo' for the migration topology.; TopicToSubscribeOn, SubscribedEventToTopicsMap: The topic to subscribe 'TopicToSubscribeOn' for 'NServiceBus.Transport.AzureServiceBus.Tests.MigrationTopologyTests+MyEvent' cannot be the same as the topic to subscribe to 'TopicToSubscribeOn' for the migration topology.; SubscribedEventToTopicsMap: Event 'NServiceBus.Transport.AzureServiceBus.Tests.MigrationTopologyTests+MyEventMappedTwice' is in the migration map and in the subscribed event to topics map. An event type cannot be marked for migration and mapped to a topic at the same time.

src/Tests/EventRouting/MigrationTopologyCreatorTests.cs

@@ -10,7 +10,9 @@ public class MigrationTopologyCreatorTests
     [Test]
     public async Task Should_create_single_topic_topology()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topology = TopicTopology.MigrateFromNamedSingleTopic("bundle-1");
+#pragma warning restore CS0618 // Type or member is obsolete
         var transportSettings = new AzureServiceBusTransport("connection-string", topology);
 
         var recordingAdministrationClient = new RecordingServiceBusAdministrationClient();
@@ -24,7 +26,9 @@ public async Task Should_create_single_topic_topology()
     [Test]
     public async Task Should_create_default_single_topic_topology()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topology = TopicTopology.MigrateFromSingleDefaultTopic();
+#pragma warning restore CS0618 // Type or member is obsolete
         var transportSettings = new AzureServiceBusTransport("connection-string", topology);
 
         var recordingAdministrationClient = new RecordingServiceBusAdministrationClient();
@@ -38,7 +42,9 @@ public async Task Should_create_default_single_topic_topology()
     [Test]
     public async Task Should_hierarchy()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topology = TopicTopology.MigrateFromTopicHierarchy("bundle-1", "bundle-2");
+#pragma warning restore CS0618 // Type or member is obsolete
         var transportSettings = new AzureServiceBusTransport("connection-string", topology);
 
         var recordingAdministrationClient = new RecordingServiceBusAdministrationClient();

src/Tests/EventRouting/MigrationTopologySubscriptionManagerTests.cs

@@ -13,7 +13,9 @@ public class MigrationTopologySubscriptionManagerTests
     [Test]
     public async Task Should_create_topology_for_events_to_migrate()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topologyOptions = new MigrationTopologyOptions
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             TopicToPublishTo = "PublishTopic",
             TopicToSubscribeOn = "SubscribeTopic",
@@ -49,7 +51,9 @@ public async Task Should_create_topology_for_events_to_migrate()
     [Test]
     public async Task Should_create_topology_for_migrated_and_not_migrated_events()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topologyOptions = new MigrationTopologyOptions
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             TopicToPublishTo = "PublishTopic",
             TopicToSubscribeOn = "SubscribeTopic",
@@ -78,7 +82,9 @@ public async Task Should_create_topology_for_migrated_and_not_migrated_events()
     [Test]
     public async Task Should_throw_when_event_is_not_mapped()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topologyOptions = new MigrationTopologyOptions
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             TopicToPublishTo = "TopicToPublishTo",
             TopicToSubscribeOn = "TopicToSubscribeOn",

src/Tests/EventRouting/MigrationTopologyTests.cs

@@ -10,7 +10,9 @@ public class MigrationTopologyTests
     [Test]
     public void Should_self_validate()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topologyOptions = new MigrationTopologyOptions
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             TopicToPublishTo = new string('a', 261),
             TopicToSubscribeOn = new string('a', 261),
@@ -37,7 +39,9 @@ public void Should_self_validate()
     [Test]
     public void Should_self_validate_consistency()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topologyOptions = new MigrationTopologyOptions
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             TopicToPublishTo = "TopicToPublishTo",
             TopicToSubscribeOn = "TopicToSubscribeOn",
@@ -62,7 +66,9 @@ public void Should_self_validate_consistency()
     [Test]
     public void Should_allow_disabling_validation()
     {
+#pragma warning disable CS0618 // Type or member is obsolete
         var topologyOptions = new MigrationTopologyOptions
+#pragma warning restore CS0618 // Type or member is obsolete
         {
             TopicToPublishTo = new string('a', 261),
             TopicToSubscribeOn = new string('a', 261)