(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 in Azure to root the files
   so that source can be cloned properly.

 - This removes the need for cleaning up existing hardcoded dirs in
   Azure from prior test runs

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

 - Additional code will be added to perform cleanup from tests

 - The Azure specific PowerShell code converts a Windows path like:

   c:\foo\bar\tmp.foo

   To something compose understands like:

   //c/foo/bar/tmp.foo

	See docker/compose#4303 (comment)

Author: Iristyle

azure-pipelines.yml

@@ -60,27 +60,30 @@ 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
   displayName: Prepare Test Environment
   name: test_prepare
 
 - powershell: |
     $domain = Get-WmiObject -Class Win32_NetworkAdapterConfiguration |
       Select -ExpandProperty DNSDomain |
       Select -First 1
+    $tempVolumeRoot = Join-Path -Path $ENV:TEMP -ChildPath ([System.IO.Path]::GetRandomFileName())
+    # Make sure to convert Windows style c:\ to compose friendly //c/
     Write-Host 'Writing compose config to disk'
     $content = @"
     AZURE_DOMAIN=$domain
+    VOLUME_ROOT=$(($tempVolumeRoot.ToLower() -replace '\\', '/') -replace '^([a-z]):', '//$1')
     "@
     $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 $tempVolumeRoot"
+    New-Item $tempVolumeRoot -Type Directory
+    Push-Location $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
     Write-Host 'Executing Pupperware specs'
     bundle exec rspec --version
     bundle exec rspec spec --fail-fast

docker-compose.override.yml

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

docker-compose.windows.yml

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

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: