code review feedback

Author: shueybubbles

.gitignore

@@ -1,62 +1,62 @@
-# SmoSamples
-
-This unit test project is meant to demonstrate features of the Sql Management Objects framework and to help developers optimize performance of their SMO-based applications.
-
-
-### Contents
-
-[About this sample](#about-this-sample)<br/>
-[Before you begin](#before-you-begin)<br/>
-[Run this sample](#run-this-sample)<br/>
-[Sample details](#sample-details)<br/>
-[Disclaimers](#disclaimers)<br/>
-[Related links](#related-links)<br/>
-
-
-<a name=about-this-sample></a>
-
-## About this sample
-
-<!-- Delete the ones that don't apply -->
-- **Applies to:** SQL Server 2016 (or higher), Azure SQL Database, Azure SQL Data Warehouse
-- **Key features:**
-- Unit tests and a docker file that demonstrate proper use of SMO features against a working SQL Server instance.
-- **Programming Language:**
-- C#
-
-<a name=before-you-begin></a>
-
-## Before you begin
-
-To run this sample, you need the following prerequisites.
-
-**Software prerequisites:**
-
-1. SQL Server 2016 (or higher) or an Azure SQL Database with the full WideWorldImporters sample database, or
-2. Docker
-3. At minimum the dotnet 2.2 SDK, or Visual Studio 2017
-
-<a name=run-this-sample></a>
-
-## Run this sample
-
-
-<a name=sample-details></a>
-
-## Sample details
-
-Each unit test demonstrates a specific aspect of SMO-based application development, either in isolation or in conjunction with other SMO components. <br/>
-Feature areas tested include:
-1. Efficient use of collections
-2. Sql query capture
-3. Events
-4. URNs
-5. Script generation
-
-
-<a name=related-links></a>
-
-## Related Links
-The SMO NuGet package is at https://www.nuget.org/packages/Microsoft.SqlServer.SqlManagementObjects/ <br/>
-Documentation for the APIs is at https://docs.microsoft.com/en-us/sql/relational-databases/server-management-objects-smo/overview-smo<br/>
+# SmoSamples
+
+This unit test project is meant to demonstrate features of the Sql Management Objects framework and to help developers optimize performance of their SMO-based applications.
+
+
+### Contents
+
+[About this sample](#about-this-sample)<br/>
+[Before you begin](#before-you-begin)<br/>
+[Run this sample](#run-this-sample)<br/>
+[Sample details](#sample-details)<br/>
+[Disclaimers](#disclaimers)<br/>
+[Related links](#related-links)<br/>
+
+
+<a name=about-this-sample></a>
+
+## About this sample
+
+<!-- Delete the ones that don't apply -->
+- **Applies to:** SQL Server 2016 (or higher), Azure SQL Database, Azure SQL Data Warehouse
+- **Key features:**
+- Unit tests and a docker file that demonstrate proper use of SMO features against a working SQL Server instance.
+- **Programming Language:**
+- C#
+
+<a name=before-you-begin></a>
+
+## Before you begin
+
+To run this sample, you need the following prerequisites.
+
+**Software prerequisites:**
+
+1. SQL Server 2016 (or higher) or an Azure SQL Database with the full WideWorldImporters sample database, or
+2. Docker
+3. At minimum the dotnet 2.2 SDK, or Visual Studio 2017
+
+<a name=run-this-sample></a>
+
+## Run this sample
+If using Docker, use runtests.sh or runtests.cmd as appropriate. If using a separate instance of SQL Server or Azure SQL Database, create a .runsettings file and run the unit tests using Visual Studio or "dotnet vstest". 
+
+<a name=sample-details></a>
+
+## Sample details
+
+Each unit test demonstrates a specific aspect of SMO-based application development, either in isolation or in conjunction with other SMO components. <br/>
+Feature areas tested include:
+1. Efficient use of collections
+2. Sql query capture
+3. Events
+4. URNs
+5. Script generation
+
+
+<a name=related-links></a>
+
+## Related Links
+The SMO NuGet package is at https://www.nuget.org/packages/Microsoft.SqlServer.SqlManagementObjects/ <br/>
+Documentation for the APIs is at https://docs.microsoft.com/sql/relational-databases/server-management-objects-smo/overview-smo<br/>
 The WideWorldImporters sample database can be found at https://github.com/Microsoft/sql-server-samples/releases/download/wide-world-importers-v1.0/WideWorldImporters-Full.bak <br/>

samples/features/sql-management-objects/README.md

@@ -1,8 +1,8 @@
-FROM mcr.microsoft.com/mssql/server:2017-latest
-WORKDIR /tmp/backup
-RUN wget -q  https://github.com/Microsoft/sql-server-samples/releases/download/wide-world-importers-v1.0/WideWorldImporters-Full.bak 
-COPY restore.sql .
-COPY restore.sh .
-COPY entrypoint.sh .
-CMD ["/bin/bash", "/tmp/backup/entrypoint.sh"]
-
+FROM mcr.microsoft.com/mssql/server:2017-latest
+WORKDIR /tmp/backup
+RUN wget -q  https://github.com/Microsoft/sql-server-samples/releases/download/wide-world-importers-v1.0/WideWorldImporters-Full.bak 
+COPY restore.sql .
+COPY restore.sh .
+COPY entrypoint.sh .
+CMD ["/bin/bash", "/tmp/backup/entrypoint.sh"]
+

samples/features/sql-management-objects/prep/dockerfile

@@ -1,3 +1,4 @@
+# Wait for SQL Server to start and be ready to accept connections
 sleep 35s
 echo sa_password is $SA_PASSWORD 
 /opt/mssql-tools/bin/sqlcmd -S . -U sa -P $SA_PASSWORD -i /tmp/backup/restore.sql

samples/features/sql-management-objects/prep/restore.sh

@@ -1,5 +1,5 @@
-RESTORE DATABASE WideWorldImporters FROM DISK = "/tmp/backup/WideWorldImporters-Full.bak" 
-WITH MOVE "WWI_Primary" TO "/var/opt/mssql/data/WideWorldImporters.mdf", 
-MOVE "WWI_Userdata" TO "/var/opt/mssql/data/WideWorldImporters_UserData.ndf", 
-MOVE "WWI_Log" TO "/var/opt/mssql/data/WideWorldImporters.ldf", MOVE "WWI_InMemory_Data_1" 
+RESTORE DATABASE WideWorldImporters FROM DISK = "/tmp/backup/WideWorldImporters-Full.bak" 
+WITH MOVE "WWI_Primary" TO "/var/opt/mssql/data/WideWorldImporters.mdf", 
+MOVE "WWI_Userdata" TO "/var/opt/mssql/data/WideWorldImporters_UserData.ndf", 
+MOVE "WWI_Log" TO "/var/opt/mssql/data/WideWorldImporters.ldf", MOVE "WWI_InMemory_Data_1" 
 TO "/var/opt/mssql/data/WideWorldImporters_InMemory_Data_1"

samples/features/sql-management-objects/prep/restore.sql

@@ -1,12 +1,10 @@
-
-using System.Diagnostics;
-using Microsoft.SqlServer.Management.Smo;
-
-namespace Microsoft.SqlServer.SmoSamples
+namespace Microsoft.SqlServer.SmoSamples
 {
     using System;
     using System.Collections.Generic;
+    using System.Diagnostics;
     using System.Text;
+    using Microsoft.SqlServer.Management.Smo;
     using Microsoft.VisualStudio.TestTools.UnitTesting;
     using NUnit.Framework;
     using Assert = NUnit.Framework.Assert;
@@ -16,6 +14,12 @@ public class CollectionSamples
     {
         public VisualStudio.TestTools.UnitTesting.TestContext TestContext { get; set; }
 
+        /// <summary>
+        /// SetDefaultInitFields tells the Server object which properties to include in the initial query
+        /// to populate of a given object type when initialized a collection of that type.
+        /// The test demonstrates the effect of using this call to enumerate Tables when accessing the FileGroup
+        /// property of each Table object
+        /// </summary>
         [TestMethod]
         public void Collection_iteration_is_faster_with_SetDefaultInitFields()
         {
@@ -26,11 +30,14 @@ public void Collection_iteration_is_faster_with_SetDefaultInitFields()
                 connectionMetrics.Reset();
                 foreach (Table table in database.Tables)
                 {
+                    // Accessing FileGroup triggers a query to fetch it
                     Trace.TraceInformation(
                         $"Unoptimized table Name: {table.Name}\tSchema:{table.Schema}\tFileGroup:{table.FileGroup}");
                 }
 
-                var unoptimizedMetrics = (connectionMetrics.QueryCount, connectionMetrics.BytesSent, connectionMetrics.BytesRead, connectionMetrics.ConnectionCount);
+                var unoptimizedMetrics = (QueryCount: connectionMetrics.QueryCount,
+                    BytesSent: connectionMetrics.BytesSent, BytesRead: connectionMetrics.BytesRead,
+                    ConnectionCount: connectionMetrics.ConnectionCount);
                 Trace.TraceInformation(string.Join($"{Environment.NewLine}\t", new[]
                 {
                     "Unoptimized metrics:",
@@ -43,11 +50,14 @@ public void Collection_iteration_is_faster_with_SetDefaultInitFields()
                 database.Tables.Refresh();
                 foreach (Table table in database.Tables)
                 {
+                    // The FileGroup property is already populated, so no extra query is needed
                     Trace.TraceInformation(
                         $"Optimized table Name: {table.Name}\tSchema:{table.Schema}\tFileGroup:{table.FileGroup}");
                 }
 
-                var optimizedMetrics = (connectionMetrics.QueryCount, connectionMetrics.BytesSent, connectionMetrics.BytesRead, connectionMetrics.ConnectionCount);
+                var optimizedMetrics = (QueryCount: connectionMetrics.QueryCount,
+                    BytesSent: connectionMetrics.BytesSent, BytesRead: connectionMetrics.BytesRead,
+                    ConnectionCount: connectionMetrics.ConnectionCount);
                 Trace.TraceInformation(string.Join($"{Environment.NewLine}\t", new[]
                 {
                     "Optimized Metrics:",