[sous-chefsGH-476] Allow specifying install method for windows_featur…

…e resources (sous-chefs#477) * [sous-chefsGH-476] Allow specifying install method for internal windows_feature resources - Introduces new attribute ['iis']['windows_feature_install_method'] the value of this vode is passed to any calls to the windows_feature resource as the resources install_method property - feature names are translated into powershell format when install method is powershell - Using powershell to install features requires passing in a different feature name - added library method to translate any feature names into the powershell format if the install mode is powershell - the look up handles the scenario where someone has already provided the feature name in the powershell format Signed-off-by: dave-q <24652224+dave-q@users.noreply.github.com> * [sous-chefsGH-476] Allow specifying install method for internal windows_feature resources install resource refactored to do the feature name translation if required by just adding the helper method in the action_class. Also refactored the install resource to enable and start the W3WVC service since every other recipe in the cookbook used to call the default recipe that did that anyway starting the W3WVC is optional and defaults to false, so that the current behaviour of that resource that doesn't change for down stream users This makes a much cleaner implemenation, no helper module monkey patched into recipe, no extra resources and to all users of the cookbook there are no breaking changes just new options if desired. Added a unit test for all the mod recipes just to check they converge, I think this just gives some confidence things are breaking Spec tests for the install resource * Update README.md Co-authored-by: Jason Field <Jason@avon-lea.co.uk> * [sous-chefsGH-476] Raise an error if the feature name cannot be translated --------- Signed-off-by: dave-q <24652224+dave-q@users.noreply.github.com> Co-authored-by: Jason Field <Jason@avon-lea.co.uk> Co-authored-by: Dan Webb <dan.webb@damacus.io>
Sev1Tech · Oct 3, 2023 · 1fd7ab2 · 1fd7ab2
1 parent 322774a
commit 1fd7ab2
Show file tree

Hide file tree

Showing 46 changed files with 893 additions and 94 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -26,18 +26,20 @@ jobs:
         os:
           - "windows-2019"
         suite:
-          - "default"
-          - "disable-default"
-          - "app"
-          - "config-property"
-          - "manager"
-          - "manager-permission"
-          - "module"
-          - "pool"
-          - "root"
-          - "section"
-          - "site"
-          - "vdir"
+          - 'default'
+          - 'disable-default'
+          - 'app'
+          - 'config-property'
+          - 'manager'
+          - 'manager-permission'
+          - 'module'
+          - 'pool'
+          - 'root'
+          - 'section'
+          - 'site'
+          - 'vdir'
+          - 'default-windowsfeatures-powershell'
+          - 'site-windowsfeatures-powershell'
       fail-fast: false
 
     steps:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@ This file is used to list changes made in each version of the iis cookbook.
 
 ## Unreleased
 
+- Allow specifying install method for windows_feature resources
+
 ## 8.0.20 - *2023-09-28*
 
 - add support for IIS pool setting `recycling.periodicRestart.requests`

diff --git a/README.md b/README.md
@@ -36,6 +36,7 @@ This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of
 - `node['iis']['pubroot']` - . default is `%SYSTEMDRIVE%\inetpub`
 - `node['iis']['docroot']` - IIS web site home directory. default is `%SYSTEMDRIVE%\inetpub\wwwroot`
 - `node['iis']['cache_dir']` - location of cached data. default is `%SYSTEMDRIVE%\inetpub\temp`
+- `node['iis']['windows_feature_install_method']` - specify the install method that will be used by any windows_feature resources. If ommitted it will not be specified and will use `windows_feature_dism` by default. Valid options are `:windows_feature_dism`, `:windows_feature_powershell`, `:windows_feature_servermanagercmd`. Default is `:windows_feature_dism`
 
 ## Resources
 

diff --git a/attributes/default.rb b/attributes/default.rb
@@ -27,3 +27,5 @@
 default['iis']['source'] = nil
 
 default['iis']['recycle']['log_events'] = 'Time, Requests, Schedule, Memory, IsapiUnhealthy, OnDemand, ConfigChange, PrivateMemory'
+
+default['iis']['windows_feature_install_method'] = :windows_feature_dism
diff --git a/documentation/iis_install.md b/documentation/iis_install.md
@@ -12,10 +12,12 @@ Simple resource to install the IIS feature
 
 ## Properties
 
-| Name                    | Type     |  Required| Description                          |
-| ----------------------- | -------- | -------- | ------------------------------------ |
-| `source`                |  String  | No       | Source to install the features from. |
-| `additional_components` |  Array   | No       | Features of IIS to install |
+| Name                    | Type           |  Required| Description                          |
+| ----------------------- | -------------- | -------- | ------------------------------------ |
+| `source`                |  String        | No       | Source to install the features from. |
+| `additional_components` |  String,Array  | No       | Features of IIS to install |
+| `install_method`        |  String, Symbol| No       | install_method to be used to any windows_features  resources. Default is :windows_feature_dism. Options are :windows_feature_dism, :windows_feature_powershell |
+| `start_iis`             | true, false    | No       | Controls whether the W3WVC service is enabled and started. Default is false
 
 ## Examples
 

diff --git a/documentation/iis_manager.md b/documentation/iis_manager.md
@@ -12,11 +12,12 @@ Configures the IIS Manager service
 
 ## Properties
 
-| Name                        | Type          | Default | Description                          |
-| --------------------------- | ------------- | ------- |  ------------------------------------ |
-| `enable_remote_management`  |  true, false  | `true`  | If remote access allowed |
-| `log_directory`             |  String       |         | Optional. The directory to write log files to |
-| `port`                      |  Integer      | `8172`  | The port the service listens on. |
+| Name                        | Type            | Default | Description                          |
+| --------------------------- | --------------- | ------- |  ------------------------------------ |
+| `enable_remote_management`  |  true, false    | `true`  | If remote access allowed |
+| `log_directory`             |  String         |         | Optional. The directory to write log files to |
+| `port`                      |  Integer        | `8172`  | The port the service listens on. |
+| `install_method`            |  String, Symbol | `:windows_feature_dism` | Optional. install_method to be used to any windows_features resources. Valid options are :windows_feature_dism, :windows_feature_powershell |
 
 ## Examples
 

diff --git a/kitchen.yml b/kitchen.yml
@@ -71,3 +71,21 @@ suites:
   - name: vdir
     run_list:
       - recipe[test::vdir]
+  - name: default-windowsfeatures-powershell
+    run_list:
+      - recipe[iis::default]
+    verifier:
+      inspec_tests:
+        - test/integration/default/spec
+    attributes:
+      iis:
+        windows_feature_install_method: windows_feature_powershell
+  - name: site-windowsfeatures-powershell
+    run_list:
+      - recipe[test::site]
+    verifier:
+      inspec_tests:
+        - test/integration/site
+    attributes:
+      iis:
+        windows_feature_install_method: windows_feature_powershell
diff --git a/recipes/default.rb b/recipes/default.rb
@@ -21,9 +21,6 @@
 iis_install 'install IIS' do
   additional_components node['iis']['components']
   source node['iis']['source']
-end
-
-service 'iis' do
-  service_name 'W3SVC'
-  action [:enable, :start]
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
 end
diff --git a/recipes/mod_application_initialization.rb b/recipes/mod_application_initialization.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-ApplicationInit'
+iis_install 'install IIS, ApplicationInit' do
+  additional_components 'IIS-ApplicationInit'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_aspnet.rb b/recipes/mod_aspnet.rb
@@ -18,11 +18,11 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-include_recipe 'iis::mod_isapi'
-
-windows_feature %w(IIS-NetFxExtensibility IIS-ASPNET) do
-  action :install
-  all !IISCookbook::Helper.older_than_windows2012?
-  source node['iis']['source'] unless node['iis']['source'].nil?
+iis_install 'install IIS, ASPNET' do
+  additional_components %w(IIS-NetFxExtensibility IIS-ASPNET)
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
 end
+
+include_recipe 'iis::mod_isapi'
diff --git a/recipes/mod_aspnet45.rb b/recipes/mod_aspnet45.rb
@@ -18,7 +18,11 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-include_recipe 'iis::mod_isapi'
+iis_install 'install IIS, ASPNET45' do
+  additional_components %w(NetFx4Extended-ASPNET45 IIS-NetFxExtensibility45 IIS-ASPNET45)
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
 
-windows_feature %w(NetFx4Extended-ASPNET45 IIS-NetFxExtensibility45 IIS-ASPNET45)
+include_recipe 'iis::mod_isapi'
diff --git a/recipes/mod_auth_anonymous.rb b/recipes/mod_auth_anonymous.rb
@@ -18,7 +18,11 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
+iis_install 'install IIS' do
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
 
 iis_section 'unlocks anonymous authentication control in web.config' do
   section 'system.webServer/security/authentication/anonymousAuthentication'

diff --git a/recipes/mod_auth_basic.rb b/recipes/mod_auth_basic.rb
@@ -18,9 +18,12 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-BasicAuthentication'
+iis_install 'install IIS, BasicAuth' do
+  additional_components 'IIS-BasicAuthentication'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
 
 iis_section 'unlocks basic authentication control in web.config' do
   section 'system.webServer/security/authentication/basicAuthentication'

diff --git a/recipes/mod_auth_digest.rb b/recipes/mod_auth_digest.rb
@@ -18,9 +18,12 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-DigestAuthentication'
+iis_install 'install IIS, DigestAuth' do
+  additional_components 'IIS-DigestAuthentication'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
 
 iis_section 'unlocks digest authentication control in web.config' do
   section 'system.webServer/security/authentication/digestAuthentication'

diff --git a/recipes/mod_auth_windows.rb b/recipes/mod_auth_windows.rb
@@ -18,9 +18,12 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-WindowsAuthentication'
+iis_install 'install IIS, WindowsAuth' do
+  additional_components 'IIS-WindowsAuthentication'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
 
 iis_section 'unlocks windows authentication control in web.config' do
   section 'system.webServer/security/authentication/windowsAuthentication'

diff --git a/recipes/mod_cgi.rb b/recipes/mod_cgi.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-CGI'
+iis_install 'install IIS, CGI' do
+  additional_components 'IIS-CGI'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_compress_dynamic.rb b/recipes/mod_compress_dynamic.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-HttpCompressionDynamic'
+iis_install 'install IIS, HttpCompressionDynamic' do
+  additional_components 'IIS-HttpCompressionDynamic'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_compress_static.rb b/recipes/mod_compress_static.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-HttpCompressionStatic'
+iis_install 'install IIS, HttpCompressionStatic' do
+  additional_components 'IIS-HttpCompressionStatic'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_ftp.rb b/recipes/mod_ftp.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature %w(IIS-FTPServer IIS-FTPSvc IIS-FTPExtensibility)
+iis_install 'install IIS, FTP' do
+  additional_components %w(IIS-FTPServer IIS-FTPSvc IIS-FTPExtensibility)
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_iis6_metabase_compat.rb b/recipes/mod_iis6_metabase_compat.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature %w(IIS-IIS6ManagementCompatibility IIS-Metabase)
+iis_install 'install IIS, Compatability, Metabase' do
+  additional_components %w(IIS-IIS6ManagementCompatibility IIS-Metabase)
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_isapi.rb b/recipes/mod_isapi.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature %w(IIS-ISAPIFilter IIS-ISAPIExtensions)
+iis_install 'install IIS, ISAPI' do
+  additional_components %w(IIS-ISAPIFilter IIS-ISAPIExtensions)
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_logging.rb b/recipes/mod_logging.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-CustomLogging'
+iis_install 'install IIS, CustomLogging' do
+  additional_components 'IIS-CustomLogging'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_management.rb b/recipes/mod_management.rb
@@ -18,9 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature %w(IIS-ManagementConsole IIS-ManagementService) do
-  action :install
-  all !IISCookbook::Helper.older_than_windows2012?
+iis_install 'install IIS, Management' do
+  additional_components %w(IIS-ManagementConsole IIS-ManagementService)
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
 end
diff --git a/recipes/mod_security.rb b/recipes/mod_security.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature %w(IIS-URLAuthorization IIS-RequestFiltering IIS-IPSecurity)
+iis_install 'install IIS, Security' do
+  additional_components %w(IIS-URLAuthorization IIS-RequestFiltering IIS-IPSecurity)
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
diff --git a/recipes/mod_tracing.rb b/recipes/mod_tracing.rb
@@ -18,6 +18,9 @@
 # limitations under the License.
 #
 
-include_recipe 'iis'
-
-windows_feature 'IIS-HttpTracing'
+iis_install 'install IIS, Tracing' do
+  additional_components 'IIS-HttpTracing'
+  source node['iis']['source']
+  install_method node['iis']['windows_feature_install_method']
+  start_iis true
+end
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,3 +27,5 @@
		default['iis']['source'] = nil

		default['iis']['recycle']['log_events'] = 'Time, Requests, Schedule, Memory, IsapiUnhealthy, OnDemand, ConfigChange, PrivateMemory'

		default['iis']['windows_feature_install_method'] = :windows_feature_dism