Feature execution plan settings and request implementation (#213)

* experimental showplan implementation (tools side only)

* fix for redundant massages from showplan executions

* moved showplan batches to new variables to make it less confusing

* returns showplan as part of batch summary with in each result summary

* cleaned up showplan resultsets

* cleaning up code and making showplan var optional

* changes all var names to showplan

* adding estimated support

* small fixes

* updatin var names and adding EPOptions struct

* adding ssms execution plan logic based on server types

* adding special actions logic

* removing redundant name changes

* execution plan query handler added

* cleaning up functions and data structures

* seperated special actions into its own class

* cleaning up special actions

* cleaning up code

* small new line fixes

* commenting out pre-yukon code

* removing all pre yukon code

* last yukon code commented out

* fixes broken tests

* adding related unit tests; integration tests incoming

* finishing tests and cleaning up code

* semantic changes

* cleaning up semantics

* changes and test fixes, also adding new exceptions into RS

* fixing special actions and cleaning up request logic

* fixing comment to trigger new build

* triggering another  build

* fixed up specialaction and added tests for it

src/Microsoft.SqlTools.ServiceLayer/QueryExecution/ResultSet.cs

@@ -27,6 +27,7 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
         // Column names of 'for xml' and 'for json' queries
         private const string NameOfForXMLColumn = "XML_F52E2B61-18A1-11d1-B105-00805F49916B";
         private const string NameOfForJSONColumn = "JSON_F52E2B61-18A1-11d1-B105-00805F49916B";
+        private const string YukonXmlShowPlanColumn = "Microsoft SQL Server 2005 XML Showplan";
 
         #endregion
 
@@ -68,6 +69,11 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
         /// </summary>
         private readonly string outputFileName;
 
+        /// <summary>
+        /// The special action which applied to this result set
+        /// </summary>
+        private SpecialAction specialAction;
+
         #endregion
 
         /// <summary>
@@ -89,6 +95,7 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
             // Initialize the storage
             outputFileName = factory.CreateFile();
             fileOffsets = new LongList<long>();
+            specialAction = new SpecialAction();
 
             // Store the factory
             fileStreamFactory = factory;
@@ -165,7 +172,9 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
                     ColumnInfo = Columns,
                     Id = Id,
                     BatchId = BatchId,
-                    RowCount = RowCount
+                    RowCount = RowCount,
+                    SpecialAction = ProcessSpecialAction()
+                    
                 };
             }
         }
@@ -236,6 +245,51 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
             });
         }
 
+        /// <summary>
+        /// Generates the execution plan from the table returned 
+        /// </summary>
+        /// <returns>An execution plan object</returns>
+        public Task<ExecutionPlan> GetExecutionPlan()
+        {
+            // Proccess the action just incase is hasn't been yet 
+            ProcessSpecialAction();
+
+            // Sanity check to make sure that the results have been read beforehand
+            if (!hasBeenRead)
+            {
+                throw new InvalidOperationException(SR.QueryServiceResultSetNotRead);
+            }
+            // Check that we this result set contains a showplan 
+            else if (!specialAction.ExpectYukonXMLShowPlan)
+            {
+                throw new Exception(SR.QueryServiceExecutionPlanNotFound);
+            }
+
+
+            return Task.Factory.StartNew(() =>
+            { 
+                string content = null;
+                string format = null;
+
+                using (IFileStreamReader fileStreamReader = fileStreamFactory.GetReader(outputFileName))
+                {
+                    // Determine the format and get the first col/row of XML
+                    content = fileStreamReader.ReadRow(0, Columns)[0].DisplayValue;
+
+                    if (specialAction.ExpectYukonXMLShowPlan) 
+                    {
+                        format = "xml";
+                    }
+                }
+                    
+                return new ExecutionPlan
+                {
+                    Format = format,
+                    Content = content
+                };
+            });
+        }
+
         /// <summary>
         /// Reads from the reader until there are no more results to read
         /// </summary>
@@ -436,6 +490,21 @@ namespace Microsoft.SqlTools.ServiceLayer.QueryExecution
             }
         }
 
+        /// <summary>
+        /// Determine the special action, if any, for this result set
+        /// </summary>
+        private SpecialAction ProcessSpecialAction() 
+        {           
+
+            // Check if this result set is a showplan 
+            if (dataReader.Columns.Length == 1 && string.Compare(dataReader.Columns[0].ColumnName, YukonXmlShowPlanColumn, StringComparison.OrdinalIgnoreCase) == 0)
+            {
+                specialAction.ExpectYukonXMLShowPlan = true;
+            }
+
+            return specialAction;
+        }
+
         #endregion
     }
 }