Fix most of the code warnings (#2519)

This fixes most of the code warnings that are in the codebase. There is
a separate commit for every warning type.

There still are 4 instances of warning **CS0649 Field '…' is never
assigned to, and will always have its default value null**:

- `PauseAfterEachItem._Options`
- `KeepOutboundLinkTargetProcessor._options`
- `OutboundLinkCheckingProcessor._options`
- `TfsWorkItemOverwriteAreasAsTagsProcessor._config`

As the warning states, these are fields which are declared, but are
never set ad hence the value is `null`. The problem is, I cannot remove
these fileds, because _they are used in code_. So I believe, that those
classes (or at least those specific code paths) are not used at all,
because it would fail with `NullReferenceException`. The only
possibility is, that the values are set somewhere by reflection? So I
will leave these warnings to someone else to look at them.

Author: MrHinsh

src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpoint.cs

@@ -22,6 +22,7 @@ namespace MigrationTools.Endpoints
 {
     public class AzureDevOpsEndpoint : Endpoint<AzureDevOpsEndpointOptions>
     {
+        [Obsolete("Dont know what this is for")]
         public override int Count => 0;
 
         public AzureDevOpsEndpoint(IOptions<AzureDevOpsEndpointOptions> optipons, EndpointEnricherContainer endpointEnrichers, IServiceProvider serviceProvider, ITelemetryLogger telemetry, ILogger<AzureDevOpsEndpoint> logger)
@@ -208,10 +209,8 @@ public async Task<IEnumerable<DefinitionType>> GetApiDefinitionsAsync<Definition
         /// <typeparam name="DefinitionType"></typeparam>
         /// <param name="routeParameters">strings that are injected into the route parameters of the definitions url</param>
         /// <param name="queryString">additional query string parameters passed to the underlying api call</param>
-        /// <param name="singleDefinitionQueryString">additional query string parameter passed when pulling the single instance details (ie. $expands, etc)</param>
-        /// <param name="queryForDetails">a boolean flag to allow caller to skip the calls for each individual definition details</param>
         /// <returns></returns>
-        public async Task<DefinitionType> GetApiDefinitionAsync<DefinitionType>(string[] routeParameters = null, string queryString = "", string singleDefinitionQueryString = "", bool queryForDetails = true)
+        public async Task<DefinitionType> GetApiDefinitionAsync<DefinitionType>(string[] routeParameters = null, string queryString = "")
             where DefinitionType : RestApiDefinition, new()
         {
             var apiPathAttribute = typeof(DefinitionType).GetCustomAttributes(typeof(ApiPathAttribute), false).OfType<ApiPathAttribute>().FirstOrDefault();
@@ -235,11 +234,10 @@ public async Task<DefinitionType> GetApiDefinitionAsync<DefinitionType>(string[]
         /// <summary>
         /// Make HTTP Request to add Revision / Version of Task Group
         /// </summary>
-        /// <param name="targetDefinitions"></param>
         /// <param name="rootDefinitions"></param>
         /// <param name="updatedDefinitions"></param>
         /// <returns>List of Mappings</returns>
-        public async Task<List<Mapping>> UpdateTaskGroupsAsync(IEnumerable<TaskGroup> targetDefinitions, IEnumerable<TaskGroup> rootDefinitions, IEnumerable<TaskGroup> updatedDefinitions)
+        public async Task<List<Mapping>> UpdateTaskGroupsAsync(IEnumerable<TaskGroup> rootDefinitions, IEnumerable<TaskGroup> updatedDefinitions)
         {
             var migratedDefinitions = new List<Mapping>();
             foreach (var definitionToBeMigrated in updatedDefinitions)
@@ -649,4 +647,4 @@ public static void AddToPath(this HttpClient client, string pathToAdd)
             client.BaseAddress = new Uri($"https://{client.BaseAddress.Host}:{client.BaseAddress.Port}{client.BaseAddress.LocalPath}{pathToAdd}{client.BaseAddress.Query}");
         }
     }
-}
+}

src/MigrationTools.Clients.AzureDevops.Rest/Processors/AzureDevOpsPipelineProcessor.cs

@@ -150,8 +150,9 @@ private IEnumerable<DefinitionType> FilterOutExistingDefinitions<DefinitionType>
         /// <summary>
         /// Filter incompatible TaskGroups
         /// </summary>
-        /// <param name="filteredTaskGroups"></param>
+        /// <param name="sourceDefinitions"></param>
         /// <param name="availableTasks"></param>
+        /// <param name="taskGroupMapping"></param>
         /// <returns>List of filtered Definitions</returns>
         private IEnumerable<BuildDefinition> FilterOutIncompatibleBuildDefinitions(IEnumerable<BuildDefinition> sourceDefinitions, IEnumerable<TaskDefinition> availableTasks, IEnumerable<Mapping> taskGroupMapping)
         {
@@ -631,7 +632,7 @@ private async Task<IEnumerable<Mapping>> CreateTaskGroupDefinitionsAsync()
 
             targetDefinitions = await Target.GetApiDefinitionsAsync<TaskGroup>(queryForDetails: false);
             var rootTargetDefinitions = SortDefinitionsByVersion(targetDefinitions).First();
-            await Target.UpdateTaskGroupsAsync(targetDefinitions, rootTargetDefinitions, updatedSourceDefinitions);
+            await Target.UpdateTaskGroupsAsync(rootTargetDefinitions, updatedSourceDefinitions);
 
             targetDefinitions = await Target.GetApiDefinitionsAsync<TaskGroup>(queryForDetails: false);
             mappings.AddRange(FindExistingMappings(sourceDefinitions, targetDefinitions.Where(d => d.Name != null), mappings));

src/MigrationTools.Clients.AzureDevops.Rest/Processors/ProcessDefinitionProcessor.cs

@@ -19,7 +19,7 @@
 
 namespace MigrationTools.Processors
 {
-    
+
     internal class ProcessorModel
     {
         public Dictionary<string, ProcessDefinitionModel> ProcessDefinitions { get; set; } = new Dictionary<string, ProcessDefinitionModel>();
@@ -151,7 +151,7 @@ await SourceFields.Values.ParallelForEachAsync(Math.Max(1, Options.MaxDegreeOfPa
             catch (Exception ex)
             {
                 Log.LogError(ex, "Failed to synchronize processes.");
-                throw ex;
+                throw;
             }
         }
 
@@ -215,7 +215,7 @@ await SyncDefinitionType<WorkItemState>(
             foreach (var field in sourceWit.Fields)
             {
                 var existingField = TargetModel.WorkItemFields.Values.FirstOrDefault(x => x.ReferenceName == field.ReferenceName);
-                //if (existingField == null || (existingField != null && field.Customization != "system")) // I don't think you can modify 
+                //if (existingField == null || (existingField != null && field.Customization != "system")) // I don't think you can modify
                 //{
                     await SyncDefinitionType<WorkItemTypeField>(
                         TargetModel.WorkItemFields,
@@ -320,7 +320,7 @@ await SyncDefinitionType<WorkItemPage>(
                                     }
                                     else
                                     {
-                                        
+
                                         // Its on a different page .. lets move pages
                                         var tempTargetGroup = existingGroup.Value.CloneAsNew();
                                         tempTargetGroup.Id = existingGroup.Value.Id;
@@ -446,7 +446,7 @@ await SyncDefinitionType<WorkItemPage>(
             Log.LogInformation($"Completed sync of work item type [{Source.Options.Name}::{sourceWit.WorkItemType.Name}] in [{Target.Options.Name}::{targetWit.WorkItemType.Name}].");
         }
 
-        
+
 
         private async Task<DefinitionType> SyncDefinitionType<DefinitionType>(Dictionary<string, DefinitionType> DataDictionary, DefinitionType sourceDef, DefinitionType targetDef, params string[] routeParams)
             where DefinitionType : RestApiDefinition, ISynchronizeable<DefinitionType>, new()
@@ -468,7 +468,7 @@ private async Task<DefinitionType> SyncDefinitionType<DefinitionType>(Dictionary
         private async Task BuildModel(ProcessorModel model, AzureDevOpsEndpoint endpoint, bool warnOnMissing)
         {
             // Grab all the procs, then iterate over them looking for procs user has configured to be
-            // sync'd. Then grab all Work Item Types for the given process and filter those by the ones user 
+            // sync'd. Then grab all Work Item Types for the given process and filter those by the ones user
             // wants to sync.
 
             Log.LogDebug($"Loading model for [{endpoint.Options.Name}].");
@@ -589,7 +589,7 @@ private async Task LoadWorkItemFields(ProcessorModel model, WorkItemType wit, Az
         }
         private async Task LoadLayout(ProcessorModel model, WorkItemTypeModel wit, AzureDevOpsEndpoint endpoint, string processId)
         {
-            wit.Layout = (await endpoint.GetApiDefinitionAsync<WorkItemLayout>(new string[] { processId, wit.WorkItemType.ReferenceName }, queryForDetails: false));
+            wit.Layout = (await endpoint.GetApiDefinitionAsync<WorkItemLayout>(new string[] { processId, wit.WorkItemType.ReferenceName }));
             foreach (var page in wit.Layout.Pages)
             {
                 var pageKey = $"{wit.WorkItemType.Name}::{page.Label}";

src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpoint.cs

@@ -20,6 +20,7 @@ public FileSystemWorkItemEndpoint(IOptions<FileSystemWorkItemEndpointOptions> op
             _innerList = new List<WorkItemData>();
         }
 
+        [Obsolete("Dont know what this is for")]
         public override int Count => GetWorkItems().Count();
 
         public void EnsureStore()
@@ -70,4 +71,4 @@ public void PersistWorkItem(WorkItemData source)
             LoadStore();
         }
     }
-}
+}

src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsEndpoint.cs

@@ -56,11 +56,9 @@ public Uri TfsProjectUri
             get { return TfsProject.Uri; }
         }
 
+        [Obsolete("Dont know what this is for")]
         public override int Count => 0;
 
-
-
-
         private TfsTeamProjectCollection GetTfsCollection()
         {
             using (var activity = ActivitySourceProvider.ActivitySource.StartActivity("GetTfsCollection", ActivityKind.Client))
@@ -191,4 +189,4 @@ private Project GetTfsProject()
             return _Project;
         }
     }
-}
+}

src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsTeamProjectEndpoint.cs

@@ -39,12 +39,11 @@ IServiceProvider Services
 
             _workItemClient = ActivatorUtilities.CreateInstance<TfsWorkItemMigrationClient>(Services, this, options);
             //networkCredentials IOptions<NetworkCredentialsOptions> networkCredentials,
-         
         }
 
+        [Obsolete("Dont know what this is for")]
         public override int Count => 0;
 
-
         public IWorkItemMigrationClient WorkItems
         {
             get
@@ -177,4 +176,4 @@ public T GetClient<T>() where T : IVssHttpClient
             return _collection.GetClient<T>();
         }
     }
-}
+}

src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemConvertor.cs

@@ -58,7 +58,7 @@ private SortedDictionary<int, RevisionItem> GetRevisionItems(RevisionCollection
                 var dictionary = items.ToDictionary(item => item.Number);
                 return new SortedDictionary<int, RevisionItem>(dictionary);
             }
-            catch (ArgumentException e)
+            catch (ArgumentException)
             {
                 Log.Warning("For some Reason there are multiple Revisions on {WorkItemId} with the same System.Rev. We will create a renumbered list...", items[0].WorkItemId);
                 var currentNumber = -1;

src/MigrationTools.Clients.TfsObjectModel/Processors/TfsExportUsersForMappingProcessorOptions.cs

@@ -10,10 +10,11 @@ public class TfsExportUsersForMappingProcessorOptions : ProcessorOptions
 
         public string WIQLQuery { get; set; }
 
-        /// `OnlyListUsersInWorkItems` 
+        /// <summary>
+        /// `OnlyListUsersInWorkItems`
         /// </summary>
         /// <default>true</default>
         public bool OnlyListUsersInWorkItems { get; set; } = true;
 
     }
-}
+}

src/MigrationTools.Clients.TfsObjectModel/Processors/TfsTestPlansAndSuitesMigrationProcessorOptions.cs

@@ -43,16 +43,10 @@ public class TfsTestPlansAndSuitesMigrationProcessorOptions : ProcessorOptions
 
         public bool FilterCompleted { get; set; }
 
-        /// <inheritdoc />
-        public bool IsProcessorCompatible(IReadOnlyList<IProcessorConfig> otherProcessors)
-        {
-            return true;
-        }
-
         public TfsTestPlansAndSuitesMigrationProcessorOptions()
         {
             MigrationDelay = 0;
             RemoveAllLinks = false;
         }
     }
-}
+}

src/MigrationTools.Clients.TfsObjectModel/Processors/TfsTestVariablesMigrationProcessorOptions.cs

@@ -7,19 +7,10 @@ namespace MigrationTools.Processors
 {
     public class TfsTestVariablesMigrationProcessorOptions : ProcessorOptions
     {
-        /// <inheritdoc />
-        public bool Enabled { get; set; }
-
         /// <inheritdoc />
         public string Processor
         {
             get { return "TestVariablesMigrationContext"; }
         }
-
-        /// <inheritdoc />
-        public bool IsProcessorCompatible(IReadOnlyList<IProcessorConfig> otherProcessors)
-        {
-            return true;
-        }
     }
-}
+}