Make property readonly when possible #3320

Evangelink · 2022-02-02T18:03:40Z

No description provided.

src/DataCollectors/Microsoft.TestPlatform.Extensions.EventLogCollector/EventLogContainer.cs

Evangelink · 2022-02-02T18:05:30Z

src/Microsoft.TestPlatform.Client/Discovery/DiscoveryRequest.cs

@@ -210,12 +210,12 @@ public DiscoveryCriteria DiscoveryCriteria
    /// <summary>
    /// Parent discovery manager
    /// </summary>
-    internal IProxyDiscoveryManager DiscoveryManager { get; private set; }
+    internal IProxyDiscoveryManager DiscoveryManager { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:06:01Z

src/Microsoft.TestPlatform.Common/ExtensionFramework/Utilities/LazyExtension.cs

@@ -102,7 +102,7 @@ public LazyExtension(Func<TExtension> creator, TMetadata metadata)
    /// </summary>
    internal bool IsExtensionCreated { get; private set; }

-    internal TestPluginInformation TestPluginInfo { get; private set; }
+    internal TestPluginInformation TestPluginInfo { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:06:36Z

src/Microsoft.TestPlatform.Common/SettingsProvider/SettingsProviderExtensionManager.cs


    /// <summary>
    /// Gets the map of settings name to settings provider.
    /// </summary>
-    public Dictionary<string, LazyExtension<ISettingsProvider, ISettingsProviderCapabilities>> SettingsProvidersMap { get; private set; }
+    public Dictionary<string, LazyExtension<ISettingsProvider, ISettingsProviderCapabilities>> SettingsProvidersMap { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:07:07Z

src/Microsoft.TestPlatform.CrossPlatEngine/Client/Parallel/ParallelRunDataAggregator.cs

@@ -66,7 +66,7 @@ public ParallelRunDataAggregator(string runSettingsXml)

    public bool IsCanceled { get; private set; }

-    public string RunSettings { get; private set; }
+    public string RunSettings { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:07:41Z

src/Microsoft.TestPlatform.CrossPlatEngine/Execution/BaseRunTests.cs

@@ -157,17 +179,17 @@ internal abstract class BaseRunTests
    /// <summary>
    /// Gets the run settings.
    /// </summary>
-    protected string RunSettings { get; private set; }
+    protected string RunSettings { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:07:53Z

src/Microsoft.TestPlatform.CrossPlatEngine/Execution/BaseRunTests.cs


    /// <summary>
    /// Gets the test execution context.
    /// </summary>
-    protected TestExecutionContext TestExecutionContext { get; private set; }
+    protected TestExecutionContext TestExecutionContext { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:08:03Z

src/Microsoft.TestPlatform.CrossPlatEngine/Execution/BaseRunTests.cs


    /// <summary>
    /// Gets the test run events handler.
    /// </summary>
-    protected ITestRunEventsHandler TestRunEventsHandler { get; private set; }
+    protected ITestRunEventsHandler TestRunEventsHandler { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:10:04Z

src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestLink.cs

@@ -38,12 +38,12 @@ public TestLink(Guid id, string name, string storage)
    /// <summary>
    /// Gets the name.
    /// </summary>
-    public string Name { get; private set; } = string.Empty;
+    public string Name { get; } = string.Empty;


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:10:34Z

src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestListCategory.cs

@@ -113,7 +113,7 @@ public static TestListCategory AllResults
    /// <summary>
    /// Gets the id.
    /// </summary>
-    public TestListCategoryId Id { get; private set; } = new TestListCategoryId();
+    public TestListCategoryId Id { get; } = new TestListCategoryId();


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:11:04Z

src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestMethod.cs


    /// <summary>
    /// Gets the class name.
    /// </summary>
-    public string ClassName { get; private set; }
+    public string ClassName { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:11:25Z

src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestResult.cs

@@ -297,7 +297,7 @@ public TimeSpan Duration
    /// <summary>
    /// Gets the computer name.
    /// </summary>
-    public string ComputerName { get; private set; }
+    public string ComputerName { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:11:34Z

src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/TestResult.cs

@@ -408,7 +408,7 @@ public string TestResultsDirectory
    /// <summary>
    /// Gets the directory containing the test result files, relative to the root results directory
    /// </summary>
-    public string RelativeTestResultsDirectory { get; private set; }
+    public string RelativeTestResultsDirectory { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:11:52Z

src/Microsoft.TestPlatform.Extensions.TrxLogger/ObjectModel/UnitTestElement.cs

@@ -51,7 +51,7 @@ public override TestType TestType
    /// <summary>
    /// Gets the test method.
    /// </summary>
-    public TestMethod TestMethod { get; private set; }
+    public TestMethod TestMethod { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:12:33Z

src/vstest.console/Processors/Utilities/ArgumentProcessorFactory.cs

@@ -77,7 +77,7 @@ internal static ArgumentProcessorFactory Create()
    /// <summary>
    /// Returns all of the available argument processors.
    /// </summary>
-    public IEnumerable<IArgumentProcessor> AllArgumentProcessors { get; private set; }
+    public IEnumerable<IArgumentProcessor> AllArgumentProcessors { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:12:53Z

src/Microsoft.TestPlatform.PlatformAbstractions/common/Tracing/RollingFileTraceListener.cs

@@ -60,7 +60,7 @@ internal string TraceFileName
    /// <value>
    /// The <see cref="StreamWriterRollingHelper"/> for the flat file.
    /// </value>
-    internal StreamWriterRollingHelper RollingHelper { get; private set; }
+    internal StreamWriterRollingHelper RollingHelper { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:13:13Z

src/Microsoft.TestPlatform.ObjectModel/DataCollector/Events/TestHostLaunchedEvent.cs

@@ -20,7 +20,7 @@ public sealed class TestHostLaunchedEventArgs : DataCollectionEventArgs

    #region Public properties

-    public int TestHostProcessId { get; private set; }
+    public int TestHostProcessId { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:13:45Z

src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectionContext.cs

@@ -85,14 +85,14 @@ protected internal DataCollectionContext(SessionId sessionId, TestCase testCase)
    /// Identifies the session under which the data collection occurs.  Will not be null.
    /// </summary>
    [DataMember]
-    public SessionId SessionId { get; private set; }
+    public SessionId SessionId { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:13:50Z

src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectionContext.cs


    /// <summary>
    /// Identifies the test execution under which the data collection occurs,
    /// or null if no such test exists.
    /// </summary>
    [DataMember]
-    public TestExecId TestExecId { get; private set; }
+    public TestExecId TestExecId { get; }


This was badly refactored by the code-fix because the field was not readonly.

Evangelink · 2022-02-02T18:15:31Z

src/Microsoft.TestPlatform.ObjectModel/DataCollector/DataCollectionContext.cs

@@ -85,14 +85,14 @@ protected internal DataCollectionContext(SessionId sessionId, TestCase testCase)
    /// Identifies the session under which the data collection occurs.  Will not be null.
    /// </summary>
    [DataMember]


REVIEW ME: Changes on this type are related to some DataMember so there might have been some impact on serialization although this doesn't seem to be part of any old serialization path (XmlSerializer).

nohwnd · 2022-02-03T14:36:52Z

Not sure what is required of me in this PR. Should the lines marked as "incorrectly refactored" be reverted? Or what am I approving here?

Evangelink · 2022-02-03T14:40:54Z

@nohwnd I have called out all cases where we used to have a readonly property (with a non-static field) before doing the big code style PR. Except for the case where there is a REVIEW ME comment, I don't expect any problem. All the changes without comment are simple follow-up refactorings (i.e. it was not readonly before but could have been changed so I am doing the change).

Make property readonly when possible

a0d37af

Evangelink commented Feb 2, 2022

View reviewed changes

src/DataCollectors/Microsoft.TestPlatform.Extensions.EventLogCollector/EventLogContainer.cs Show resolved Hide resolved

Evangelink commented Feb 2, 2022

View reviewed changes

Update more properties

6d47155

Evangelink commented Feb 2, 2022

View reviewed changes

Move method content to ctor to allow readonly property

0c81e61

nohwnd approved these changes Feb 3, 2022

View reviewed changes

Evangelink merged commit cc10486 into microsoft:main Feb 3, 2022

Evangelink deleted the readonly-properties branch February 3, 2022 15:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make property readonly when possible #3320

Make property readonly when possible #3320

Evangelink commented Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

Evangelink Feb 2, 2022

nohwnd commented Feb 3, 2022

Evangelink commented Feb 3, 2022

Make property readonly when possible #3320

Make property readonly when possible #3320

Conversation

Evangelink commented Feb 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nohwnd commented Feb 3, 2022

Evangelink commented Feb 3, 2022