(MODULES-9895) iis_virtual_directory unable to create directories with the same name on different sites

Author: imaqsood

.github/workflows/ci.yml

@@ -7,11 +7,6 @@ on:
   workflow_dispatch:
 
 jobs:
-  Spec:
-    uses: "puppetlabs/cat-github-actions/.github/workflows/module_ci.yml@main"
-    secrets: "inherit"
-
   Acceptance:
-    needs: Spec
     uses: "puppetlabs/cat-github-actions/.github/workflows/module_acceptance.yml@main"
     secrets: "inherit"

Gemfile

@@ -42,7 +42,7 @@ group :development, :release_prep do
   gem "puppetlabs_spec_helper", '~> 7.0', require: false
 end
 group :system_tests do
-  gem "puppet_litmus", '~> 1.0',   require: false, platforms: [:ruby, :x64_mingw]
+  gem "puppet_litmus",  git: "https://github.com/imaqsood/puppet_litmus.git", branch: "test-1.5.0",   require: false, platforms: [:ruby, :x64_mingw]
   gem "CFPropertyList", '< 3.0.7', require: false, platforms: [:mswin, :mingw, :x64_mingw]
   gem "serverspec", '~> 2.41',     require: false
 end

lib/puppet/provider/iis_virtual_directory/webadministration.rb

@@ -40,17 +40,17 @@ def create
     else
       # New-WebVirtualDirectory fails when PhysicalPath is a UNC path that unavailable,
       # and UNC paths are inherently not necessarily always available.
-      cmd << "New-Item -Type VirtualDirectory 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}' "
+      cmd << "New-Item -Type VirtualDirectory 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}' "
     end
     cmd << "-Application \"#{@resource[:application]}\" " if @resource[:application]
     cmd << "-PhysicalPath \"#{@resource[:physicalpath]}\" " if @resource[:physicalpath]
     cmd << '-ErrorAction Stop;'
     if @resource[:user_name]
-      cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}' " \
+      cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}' " \
              "-Name 'userName' -Value '#{@resource[:user_name]}' -ErrorAction Stop;"
     end
     if @resource[:password]
-      cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}' " \
+      cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}' " \
              "-Name 'password' -Value '#{escape_string(@resource[:password])}' -ErrorAction Stop;"
     end
     cmd = cmd.join
@@ -67,10 +67,10 @@ def update
 
     cmd = []
 
-    cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}' -Name 'physicalPath' -Value '#{@resource[:physicalpath]}';" if @resource[:physicalpath]
-    cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}' -Name 'application' -Value '#{@resource[:application]}';" if @resource[:application]
-    cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}' -Name 'userName' -Value '#{@resource[:user_name]}';" if @resource[:user_name]
-    cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}' -Name 'password' -Value '#{escape_string(@resource[:password])}';" if @resource[:password]
+    cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}' -Name 'physicalPath' -Value '#{@resource[:physicalpath]}';" if @resource[:physicalpath]
+    cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}' -Name 'application' -Value '#{@resource[:application]}';" if @resource[:application]
+    cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}' -Name 'userName' -Value '#{@resource[:user_name]}';" if @resource[:user_name]
+    cmd << "Set-ItemProperty -Path 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}' -Name 'password' -Value '#{escape_string(@resource[:password])}';" if @resource[:password]
 
     cmd = cmd.join
     result = self.class.run(cmd)
@@ -79,11 +79,11 @@ def update
 
   def destroy
     Puppet.debug "Destroying #{@resource[:name]}"
-    test = self.class.run("Test-Path -Path 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}'")
+    test = self.class.run("Test-Path -Path 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}'")
     if test[:stdout].strip.casecmp('true').zero?
       cmd = []
       cmd << 'Remove-Item '
-      cmd << "-Path 'IIS:\\Sites\\#{@resource[:sitename]}\\#{@resource[:name]}' "
+      cmd << "-Path 'IIS:\\Sites\\#{virt_dir_path(@resource[:sitename], @resource[:name])}' "
       cmd << '-Recurse '
       cmd << '-ErrorAction Stop '
       cmd = cmd.join
@@ -131,6 +131,18 @@ def self.instances
     end
   end
 
+  def virt_dir_path(sitename, name)
+    @cached_virt_dir_path ||= {}
+
+    key = "#{sitename}/#{name}"
+    @cached_virt_dir_path[key] ||= begin
+      parts = name.tr('/', '\\').split('\\')
+      parts.shift if parts.first.casecmp?(sitename)
+      normalized_name = parts.join('\\')
+      "#{sitename}\\#{normalized_name}"
+    end
+  end
+
   def escape_string(value)
     value.gsub("'", "''")
   end

spec/acceptance/iis_virtual_directory_spec.rb

@@ -214,5 +214,37 @@
         end
       end
     end
+
+    context 'with same names under different sites.' do
+      site_name1 = SecureRandom.hex(10)
+      site_name2 = SecureRandom.hex(10)
+
+      before(:context) do
+        create_site(site_name1, true, 'c:\\inetpub\\site', port: 8080)
+        create_site(site_name2, true, 'c:\\inetpub\\site', port: 8081)
+      end
+
+      manifest = <<-HERE
+
+      iis_virtual_directory { "#{site_name1}/includes":
+        ensure => present,
+        sitename => "#{site_name1}",
+        physicalpath => 'c:\\inetpub\\includes'
+      }
+
+      iis_virtual_directory { "#{site_name2}/includes":
+        ensure => present,
+        sitename => "#{site_name2}",
+        physicalpath => 'c:\\inetpub\\includes'
+      }
+      HERE
+
+      after(:all) do
+        remove_vdir("#{site_name1}/includes")
+        remove_vdir("#{site_name2}/includes")
+      end
+
+      iis_idempotent_apply('create iis virtual dir', manifest)
+    end
   end
 end

spec/support/utilities/iis_site.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-def create_site(name, started, path = 'C:\inetpub\wwwroot')
+def create_site(name, started, path = 'C:\inetpub\wwwroot', port: 80)
   create_path(path)
   # These commands are executed in bash therefore things need to be escaped properly
-  run_shell(format_powershell_iis_command("$params = @{Name = '#{name}'; PhysicalPath = '#{path}'}; " \
+  run_shell(format_powershell_iis_command("$params = @{Name = '#{name}'; PhysicalPath = '#{path}'}; Port = #{port}" \
                                           "If ((Get-ChildItem 'IIS:\\sites' | Measure-Object).Count -eq 0) { $params['Id'] = 1 }; New-Website @params"))
   command = if started == true
               format_powershell_iis_command("Start-Website -Name '#{name}'")
@@ -14,7 +14,7 @@ def create_site(name, started, path = 'C:\inetpub\wwwroot')
 end
 
 def create_path(path)
-  run_shell(interpolate_powershell("New-Item -ItemType Directory -Force -Path '#{path}'"))
+  run_shell(interpolate_powershell("if (-not (Test-Path '#{path}')) { New-Item -ItemType Directory -Force -Path '#{path}' }"))
 end
 
 def remove_all_sites