Add module restore build rule, move start script, fix script analyzer

code for tests.

Change test module path so it works

Generalise module path resolution

Add module parse error, remove test debug code

Use simpler module loading API

Import ScriptAnalyzer based on path precedence, not version

Remove PSES installing itself, remove zip file

Remove -EditorServicesVersion reference in ServerTestBase.cs

Move Start-PSES script to new location

Update testing Start-PSES script path

Change URL of Start-PSES script in comment

Author: rjmholt

.gitignore

@@ -33,6 +33,7 @@ docs/_site/
 docs/_repo/
 docs/metadata/
 tools/
+*.zip
 
 # quickbuild.exe
 /VersionGeneratingLogs/
@@ -67,4 +68,4 @@ module/PowerShellEditorServices/Commands/en-US/*-help.xml
 module/PowerShellEditorServices/Third\ Party\ Notices.txt
 
 # Visual Studio for Mac generated file
-*.userprefs
+*.userprefs

PowerShellEditorServices.build.ps1

@@ -5,14 +5,21 @@
 
 param(
     [ValidateSet("Debug", "Release")]
-    [string]$Configuration = "Debug"
+    [string]$Configuration = "Debug",
+
+    [string]$PsesSubmodulePath = "$PSScriptRoot/module",
+
+    [string]$ModulesJsonPath = "$PSScriptRoot/modules.json",
+
+    [string]$DefaultModuleRepository = "PSGallery"
 )
 
 #Requires -Modules @{ModuleName="InvokeBuild";ModuleVersion="3.2.1"}
 
 $script:IsCIBuild = $env:APPVEYOR -ne $null
 $script:IsUnix = $PSVersionTable.PSEdition -and $PSVersionTable.PSEdition -eq "Core" -and !$IsWindows
 $script:TargetFrameworksParam = "/p:TargetFrameworks=\`"$(if (!$script:IsUnix) { "net451;" })netstandard1.6\`""
+$script:SaveModuleSupportsAllowPrerelease = (Get-Command Save-Module).Parameters.ContainsKey("AllowPrerelease")
 
 if ($PSVersionTable.PSEdition -ne "Core") {
     Add-Type -Assembly System.IO.Compression.FileSystem
@@ -179,7 +186,7 @@ task TestProtocol -If { !$script:IsUnix} {
 task TestHost -If { !$script:IsUnix} {
     Set-Location .\test\PowerShellEditorServices.Test.Host\
     exec { & $script:dotnetExe build -c $Configuration -f net452 }
-    exec { & $script:dotnetExe xunit -configuration $Configuration -framework net452 -verbose -nobuild -x86 }
+    exec { & $script:dotnetExe xunit -configuration $Configuration -framework net452 -verbose -nobuild }
 }
 
 task CITest ?Test, {
@@ -220,6 +227,67 @@ task LayoutModule -After Build {
     }
 }
 
+task RestorePsesModules -After Build {
+    $submodulePath = (Resolve-Path $PsesSubmodulePath).Path + [IO.Path]::DirectorySeparatorChar
+    Write-Host "`nRestoring EditorServices modules..."
+
+    # Read in the modules.json file as a hashtable so it can be splatted
+    $moduleInfos = @{}
+
+    (Get-Content -Raw $ModulesJsonPath | ConvertFrom-Json).PSObject.Properties | ForEach-Object {
+        $name = $_.Name
+        $body = @{
+            Name = $name
+            MinimumVersion = $_.Value.MinimumVersion
+            MaximumVersion = $_.Value.MaximumVersion
+            Repository = if ($_.Value.Repository) { $_.Value.Repository } else { $DefaultModuleRepository }
+            Path = $submodulePath
+        }
+
+        if (-not $name)
+        {
+            throw "EditorServices module listed without name in '$ModulesJsonPath'"
+        }
+
+        if ($script:SaveModuleSupportsAllowPrerelease)
+        {
+            $body += @{ AllowPrerelease = $_.Value.AllowPrerelease }
+        }
+
+        $moduleInfos.Add($name, $body)
+    }
+
+    # Save each module in the modules.json file
+    foreach ($moduleName in $moduleInfos.Keys)
+    {
+        if (Test-Path -Path (Join-Path -Path $submodulePath -ChildPath $moduleName))
+        {
+            Write-Host "`tModule '${moduleName}' already detected. Skipping"
+            continue
+        }
+
+        $moduleInstallDetails = $moduleInfos[$moduleName]
+
+        $splatParameters = @{
+           Name = $moduleName
+           MinimumVersion = $moduleInstallDetails.MinimumVersion
+           MaximumVersion = $moduleInstallDetails.MaximumVersion
+           Repository = if ($moduleInstallDetails.Repository) { $moduleInstallDetails.Repository } else { $DefaultModuleRepository }
+           Path = $submodulePath
+        }
+
+        if ($script:SaveModuleSupportsAllowPrerelease)
+        {
+            $splatParameters += @{ AllowPrerelease = $moduleInstallDetails.AllowPrerelease }
+        }
+
+        Write-Host "`tInstalling module: ${moduleName}"
+
+        Save-Module @splatParameters
+    }
+    Write-Host "`n"
+}
+
 task BuildCmdletHelp {
     New-ExternalHelp -Path $PSScriptRoot\module\docs -OutputPath $PSScriptRoot\module\PowerShellEditorServices\Commands\en-US -Force
 }

module/Start-EditorServices.ps1 renamed to module/PowerShellEditorServices/Start-EditorServices.ps1

@@ -14,14 +14,9 @@
 #       canonical version of this script at the PowerShell Editor
 #       Services GitHub repository:
 #
-#       https://github.com/PowerShell/PowerShellEditorServices/blob/master/module/Start-EditorServices.ps1
+#       https://github.com/PowerShell/PowerShellEditorServices/blob/master/module/PowerShellEditorServices/Start-EditorServices.ps1
 
 param(
-    [Parameter(Mandatory=$true)]
-    [ValidateNotNullOrEmpty()]
-    [string]
-    $EditorServicesVersion,
-
     [Parameter(Mandatory=$true)]
     [ValidateNotNullOrEmpty()]
     [string]
@@ -97,6 +92,13 @@ function ExitWithError($errorString) {
     exit 1;
 }
 
+function WriteSessionFile($sessionInfo) {
+    $sessionInfoJson = ConvertTo-Json -InputObject $sessionInfo -Compress
+    Log "Writing session file with contents:"
+    Log $sessionInfoJson
+    $sessionInfoJson | Set-Content -Force -Path "$SessionDetailsPath" -ErrorAction Stop
+}
+
 # Are we running in PowerShell 2 or earlier?
 if ($PSVersionTable.PSVersion.Major -le 2) {
     # No ConvertTo-Json on PSv2 and below, so write out the JSON manually
@@ -106,12 +108,6 @@ if ($PSVersionTable.PSVersion.Major -le 2) {
     ExitWithError "Unsupported PowerShell version $($PSVersionTable.PSVersion), language features are disabled."
 }
 
-function WriteSessionFile($sessionInfo) {
-    $sessionInfoJson = ConvertTo-Json -InputObject $sessionInfo -Compress
-    Log "Writing session file with contents:"
-    Log $sessionInfoJson
-    $sessionInfoJson | Set-Content -Force -Path "$SessionDetailsPath" -ErrorAction Stop
-}
 
 if ($host.Runspace.LanguageMode -eq 'ConstrainedLanguage') {
     WriteSessionFile @{
@@ -244,32 +240,11 @@ if ((Test-ModuleAvailable "PowerShellGet") -eq $false) {
     # TODO: WRITE ERROR
 }
 
-# Check if the expected version of the PowerShell Editor Services
-# module is installed
-$parsedVersion = New-Object System.Version @($EditorServicesVersion)
-if ((Test-ModuleAvailable "PowerShellEditorServices" $parsedVersion) -eq $false) {
-    if ($ConfirmInstall -and $isPS5orLater) {
-        # TODO: Check for error and return failure if necessary
-        LogSection "Install PowerShellEditorServices"
-        Install-Module "PowerShellEditorServices" -RequiredVersion $parsedVersion -Confirm
-    }
-    else {
-        # Indicate to the client that the PowerShellEditorServices module
-        # needs to be installed
-        Write-Output "needs_install"
-    }
-}
-
 try {
     LogSection "Start up PowerShellEditorServices"
     Log "Importing PowerShellEditorServices"
 
-    if ($isPS5orLater) {
-        Import-Module PowerShellEditorServices -RequiredVersion $parsedVersion -ErrorAction Stop
-    }
-    else {
-        Import-Module PowerShellEditorServices -Version $parsedVersion -ErrorAction Stop
-    }
+    Import-Module PowerShellEditorServices -ErrorAction Stop
 
     # Locate available port numbers for services
     Log "Searching for available socket port for the language service"

modules.json

@@ -0,0 +1,12 @@
+{
+    "PSScriptAnalyzer":{
+        "MinimumVersion":"1.6",
+        "MaximumVersion":"1.99",
+        "AllowPrerelease":false
+    },
+    "Plaster":{
+        "MinimumVersion":"1.0",
+        "MaximumVersion":"1.99",
+        "AllowPrerelease":false
+    }
+}