(MODULES-4257) Modify instance and features for SQL Server 2016

Previously the sqlserver_instance and sqlserver_feature acceptance tests were
failing.  This was mainly due to SQL Server 2016 not having a feature for the
SQL Management Studio (ADV_SSMS and SSMS).  However it was later found that the
super features called Tools and SQL were not providing an adequate abstraction
e.g. they were not rolled up in the Facter facts.  This commit adds support for
SQL Server 2016 by the following:
- Deprecating the use of 'Tools' in the sqlserver_features and 'SQL' in the
  sqlserver_instance custom types.  These super features will continue to
  function however use of them will generate a deprecation warning
- The acceptance tests for the super features was removed
- Most tests which referred to ADV_SSMS and SSMS were removed.  Where not
  possible, they were guarded to not be tested on SQL Server 2016.
- An installation media version detection method was added as Dot Net 3.5 is
  not required for SQL Server 2016 installation.  This is only applicable for
  SQL Server 2012 and 2014.
- Refactored the instances method for sqlserver_features to support multiple
  server editions on a server but until MODULES-5060 is resolved, only the first
  set is returned.

Author: glennsarti

lib/puppet/provider/sqlserver_features/mssql.rb

@@ -1,5 +1,7 @@
 require 'json'
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'sqlserver'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'puppet_x/sqlserver/server_helper'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'puppet_x/sqlserver/features'))
 
 FEATURE_RESERVED_SWITCHES =
   %w(AGTSVCACCOUNT AGTSVCPASSWORD ASSVCACCOUNT AGTSVCPASSWORD PID
@@ -10,18 +12,25 @@ def self.instances
     instances = []
     result = Facter.value(:sqlserver_features)
     debug "Parsing result #{result}"
-    result = !result[SQL_2014].empty? ? result[SQL_2014] : result[SQL_2012]
-    if !result.empty?
-      existing_instance = {:name => "Generic Features",
-                           :ensure => :present,
-                           :features => result.sort
+
+    ALL_SQL_VERSIONS.each do |sql_version|
+      next if result[sql_version].empty?
+      instance_props = {:name => "Generic Features",
+                        :ensure => :present,
+                        :features => result[sql_version].sort
       }
-      debug "Parsed features = #{existing_instance[:features]}"
+      debug "Parsed features = #{instance_props[:features]}"
 
-      instance = new(existing_instance)
+      instance = new(instance_props)
       debug "Created instance #{instance}"
       instances << instance
+
+      # Due to MODULES-5060 we can only output one feature set.  If we output
+      # multiple then it is not possible to install or uninstall due to multiple
+      # resources with the same name.
+      break
     end
+
     instances
   end
 
@@ -82,8 +91,7 @@ def create_temp_for_install_switch
       config_file = ["[OPTIONS]"]
       @resource[:install_switches].each_pair do |k, v|
         if FEATURE_RESERVED_SWITCHES.include? k
-          warn("Reserved switch [#{k}] found for `install_switches`, please know the provided value
-may be overridden by some command line arguments")
+          warn("Reserved switch [#{k}] found for `install_switches`, please know the provided value may be overridden by some command line arguments")
         end
         if v.is_a?(Numeric) || (v.is_a?(String) && v =~ /^(true|false|1|0)$/i)
           config_file << "#{k}=#{v}"
@@ -111,7 +119,11 @@ def create
       warn "Uninstalling all sql server features not tied into an instance because an empty array was passed, please use ensure absent instead."
       destroy
     else
-      installNet35(@resource[:windows_feature_source])
+      instance_version = PuppetX::Sqlserver::ServerHelper.sql_version_from_install_source(@resource[:source])
+      Puppet.debug("Installation source detected as version #{instance_version}") unless instance_version.nil?
+
+      installNet35(@resource[:windows_feature_source]) unless instance_version == SQL_2016
+
       debug "Installing features #{@resource[:features]}"
       add_features(@resource[:features])
       @property_hash[:features] = @resource[:features]

lib/puppet/provider/sqlserver_instance/mssql.rb

@@ -1,6 +1,7 @@
 require 'json'
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'sqlserver'))
-
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'puppet_x/sqlserver/server_helper'))
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'puppet_x/sqlserver/features'))
 
 INSTANCE_RESERVED_SWITCHES =
   %w(AGTSVCACCOUNT AGTSVCPASSWORD ASSVCACCOUNT AGTSVCPASSWORD PID
@@ -70,7 +71,11 @@ def create
       warn "Uninstalling all features for instance #{@resource[:name]} because an empty array was passed, please use ensure absent instead."
       destroy
     else
-      installNet35(@resource[:windows_feature_source])
+      instance_version = PuppetX::Sqlserver::ServerHelper.sql_version_from_install_source(@resource[:source])
+      Puppet.debug("Installation source detected as version #{instance_version}") unless instance_version.nil?
+
+      installNet35(@resource[:windows_feature_source]) unless instance_version == SQL_2016
+
       add_features(@resource[:features])
     end
   end
@@ -80,8 +85,7 @@ def create_temp_for_install_switch
       config_file = ["[OPTIONS]"]
       @resource[:install_switches].each_pair do |k, v|
         if INSTANCE_RESERVED_SWITCHES.include? k
-          warn("Reserved switch [#{k}] found for `install_switches`, please know the provided value
-may be overridden by some command line arguments")
+          warn("Reserved switch [#{k}] found for `install_switches`, please know the provided value may be overridden by some command line arguments")
         end
         if v.is_a?(Numeric) || (v.is_a?(String) && v =~ /^(true|false|1|0)$/i)
           config_file << "#{k}=#{v}"

lib/puppet/type/sqlserver_features.rb

@@ -36,11 +36,11 @@
 
   newproperty(:features, :array_matching => :all) do
     desc 'Specifies features to install, uninstall, or upgrade. The list of top-level features include
-         Tools, BC, Conn, SSMS, ADV_SSMS, SDK, IS and MDS. The Tools feature will install Management
-          Tools, Books online components, SQL Server Data Tools, and other shared components.'
-    newvalues(:Tools, :BC, :Conn, :SSMS, :ADV_SSMS, :SDK, :IS, :MDS)
+         BC, Conn, SSMS, ADV_SSMS, SDK, IS and MDS.'
+    newvalues(:Tools, :BC, :Conn, :SSMS, :ADV_SSMS, :SDK, :IS, :MDS, :BOL, :DREPLAY_CTLR, :DREPLAY_CLT)
     munge do |value|
       if PuppetX::Sqlserver::ServerHelper.is_super_feature(value)
+        Puppet.deprecation_warning("Using #{value} is deprecated for features in sql_features resources")
         PuppetX::Sqlserver::ServerHelper.get_sub_features(value).collect { |v| v.to_s }
       else
         value

lib/puppet/type/sqlserver_instance.rb

@@ -27,11 +27,11 @@
 
   newproperty(:features, :array_matching => :all) do
     desc 'Specifies features to install, uninstall, or upgrade. The list of top-level features include
-          SQL, SQLEngine, Replication, FullText, DQ AS, and RS. The SQL feature will install the Database Engine,
-          Replication, Full-Text, and Data Quality Services (DQS) server.'
-    newvalues(:SQL, :SQLEngine, :Replication, :FullText, :DQ, :AS, :RS)
+          SQLEngine, Replication, FullText, DQ AS, and RS.'
+    newvalues(:SQL, :SQLEngine, :Replication, :FullText, :DQ, :AS, :RS, :POLYBASE, :ADVANCEDANALYTICS)
     munge do |value|
       if PuppetX::Sqlserver::ServerHelper.is_super_feature(value)
+        Puppet.deprecation_warning("Using #{value} is deprecated for features in sql_instance resources")
         PuppetX::Sqlserver::ServerHelper.get_sub_features(value).collect { |v| v.to_s }
       else
         value

lib/puppet_x/sqlserver/server_helper.rb

@@ -21,6 +21,33 @@ def self.is_domain_or_local_user?(user, hostname)
           true
         end
       end
+
+      # Returns either SQL_2016, SQL_2014 or SQL_2012 if it can determine the SQL Version from the install source
+      # Returns nil if it can not be determined
+      def self.sql_version_from_install_source(source_dir)
+        # Attempt to read the Mediainfo.xml file in the root of the install media
+        media_file = File.expand_path("#{source_dir}/MediaInfo.xml")
+        return nil unless File.exist?(media_file)
+        # As we don't have a XML parser easily, just use simple text matching to find the following XML element. This
+        # also means we can just ignore BOM markers etc.
+        #     <Property Id="BaselineVersion" Value="xx.yyy.zz." />
+        content = File.read(media_file)
+        index1 = content.index('"BaselineVersion"')
+        return nil if index1.nil?
+        index2 = content.index('/>',index1) 
+        return nil if index2.nil?
+        content = content.slice(index1 + 18, index2 - index1 - 18)
+        # Extract the version number from the text snippet
+        #     Value="xx.yyy.zz."
+        ver = content.match('"(.+)"')
+        return nil if ver.nil?
+
+        return SQL_2016 if ver[1].start_with?('13.')
+        return SQL_2014 if ver[1].start_with?('12.')
+        return SQL_2012 if ver[1].start_with?('11.')
+
+        nil
+      end
     end
   end
 end

spec/acceptance/sqlserver_instance_spec.rb

@@ -81,7 +81,7 @@ def sql_query_is_user_sysadmin(username)
     end
 
     inst_name = new_random_instance_name
-    features = ['SQL', 'SQLEngine', 'Replication', 'FullText', 'DQ']
+    features = ['SQLEngine', 'Replication', 'FullText', 'DQ']
 
     it "create #{inst_name} instance" do
       ensure_sqlserver_instance(host, features, inst_name,'present',"['Administrator','ExtraSQLAdmin']")
@@ -114,25 +114,6 @@ def sql_query_is_user_sysadmin(username)
     end
   end
 
-  context "Feature has only one 'SQL'", {:testrail => ['89032']} do
-    inst_name = new_random_instance_name
-    features = ['SQL']
-
-    after(:all) do
-      ensure_sqlserver_instance(host, features, inst_name, 'absent')
-    end
-
-    it "create #{inst_name} instance with only one SQL feature" do
-      ensure_sqlserver_instance(host, features, inst_name)
-
-      validate_sql_install(host, {:version => version}) do |r|
-        expect(r.stdout).to match(/#{inst_name}\s+Database Engine Services/)
-        expect(r.stdout).to match(/#{inst_name}\s+SQL Server Replication/)
-        expect(r.stdout).to match(/#{inst_name}\s+Data Quality Services/)
-      end
-    end
-  end
-
   context "Feature has only one 'RS'", {:testrail => ['89034']} do
    inst_name = new_random_instance_name
    features = ['RS']