(maint) Allow configurable volumes root

 - With long-running hosts, rooting the volumes inside of the git
   cloned source directory is problematic.

   When tests are cancelled and containers remain running, files can
   be locked, preventing subsequent runs from proceeding correctly.

   Instead, generate a temporary directory (on Windows) to root the
   files so that source can be cloned properly.

 - This removes the need for cleaning up existing hardcoded dirs from
   prior test runs, but we still make a best effort in the Azure job
   to do cleanup

 - For now this will continue to default to `.` in Travis, given hosts
   are ephemeral.

   On Windows hosts, this will be in the temp dir for the given user.

   docker-compose understands Windows paths on the left hand side of
   the volume mapping, so no conversions are necessary.

   This was not always the case per:
	 docker/compose#4303 (comment)

 - Stuff the temp dir in an Azure variable so it can be used in a later
   cleanup stage

 - Set the temp dir to give Users group full control to prevent the
   containers from running into permissions issues

 - Additional code will be added to perform cleanup from tests

Author: Iristyle

commercial/azure-pipelines.yml

@@ -60,13 +60,9 @@ steps:
     bundle install --with test --path '.bundle/gems'
     # make sure windows yml slots in as the default override
     Copy-Item ./docker-compose.windows.yml ./docker-compose.override.yml -Force
-    Write-Host 'Forcibly removing previous cluster config / data'
-    Remove-Item 'volumes' -Force -Recurse -ErrorAction SilentlyContinue;
-    New-Item 'volumes' -Type Directory
-    Push-Location 'volumes'
-    'code', 'puppet', 'serverdata', 'puppetdb\ssl', 'puppetdb-postgres\data' |
-      % { New-Item $_ -Type Directory }
-    Pop-Location
+    # set an Azure variable for temp volumes root
+    $tempVolumeRoot = Join-Path -Path $ENV:TEMP -ChildPath ([System.IO.Path]::GetRandomFileName())
+    Write-Host "##vso[task.setvariable variable=TempVolumeRoot]$tempVolumeRoot"
   displayName: Prepare Test Environment
   name: test_prepare
 
@@ -77,10 +73,20 @@ steps:
     Write-Host 'Writing compose config to disk'
     $content = @"
     AZURE_DOMAIN=$domain
+    VOLUME_ROOT=$ENV:TempVolumeRoot
     "@
     $Utf8NoBomEncoding = New-Object System.Text.UTF8Encoding $False
     [System.IO.File]::WriteAllLines(".env", $content, $Utf8NoBomEncoding)
     Get-Content -Path '.env'
+    Write-Host "Creating volumes directory structure in $ENV:TempVolumeRoot"
+    New-Item $ENV:TempVolumeRoot -Type Directory
+    Push-Location $ENV:TempVolumeRoot
+    New-Item 'volumes' -Type Directory
+    'volumes\code', 'volumes\puppet', 'volumes\serverdata', 'volumes\puppetdb\ssl', 'volumes\puppetdb-postgres\data' |
+      % { New-Item $_ -Type Directory }
+    Pop-Location
+    # Hack: grant all users access to this temp dir for the sake of Docker daemon
+    icacls $ENV:TempVolumeRoot /grant Users:"(OI)(CI)F" /T
     Write-Host 'Executing Pupperware specs'
     bundle exec rspec --version
     bundle exec rspec spec --fail-fast
@@ -100,6 +106,8 @@ steps:
     docker container prune --force
     Write-Host 'Pruning images'
     docker image prune --filter "dangling=true" --force
+    Write-Host "Cleaning up temporary volume: $ENV:TempVolumeRoot"
+    Remove-Item $ENV:TempVolumeRoot -Force -Recurse -ErrorAction Continue
   displayName: Container Cleanup
   timeoutInMinutes: 3
   condition: always()

commercial/docker-compose.override.yml

@@ -4,5 +4,5 @@ services:
   postgres:
     image: postgres:9.6
     volumes:
-      - ./volumes/puppetdb-postgres/data:/var/lib/postgresql/data/
+      - ${VOLUME_ROOT:-.}/volumes/puppetdb-postgres/data:/var/lib/postgresql/data/
       - ./postgres-custom:/docker-entrypoint-initdb.d

commercial/docker-compose.windows.yml

@@ -12,5 +12,5 @@ services:
     environment:
       - PGDATA=c:\data
     volumes:
-      - ./volumes/puppetdb-postgres/data:c:\data
+      - ${VOLUME_ROOT:-.}/volumes/puppetdb-postgres/data:c:\data
       - ./postgres-custom:c:\docker-entrypoint-initdb.d

commercial/docker-compose.yml

@@ -14,9 +14,9 @@ services:
       - DNS_ALT_NAMES=puppet,${DNS_ALT_NAMES:-}
       - PUPPETDB_SERVER_URLS=https://puppetdb:8081
     volumes:
-      - ./volumes/code:/etc/puppetlabs/code/
-      - ./volumes/puppet:/etc/puppetlabs/puppet/
-      - ./volumes/serverdata:/opt/puppetlabs/server/data/puppetserver/
+      - ${VOLUME_ROOT:-.}/volumes/code:/etc/puppetlabs/code/
+      - ${VOLUME_ROOT:-.}/volumes/puppet:/etc/puppetlabs/puppet/
+      - ${VOLUME_ROOT:-.}/volumes/serverdata:/opt/puppetlabs/server/data/puppetserver/
 
   postgres:
     environment:
@@ -43,7 +43,7 @@ services:
       - postgres
       - puppet
     volumes:
-      - ./volumes/puppetdb/ssl:/etc/puppetlabs/puppet/ssl/
+      - ${VOLUME_ROOT:-.}/volumes/puppetdb/ssl:/etc/puppetlabs/puppet/ssl/
 
 networks:
   default: