Fix #99: 'using module' relative path resolution

appveyor.yml

@@ -1,5 +1,5 @@
 version: '$(core_version).{build}'
-os: Unstable
+os: WMF 5
 configuration: Release
 clone_depth: 10
 

src/PowerShellEditorServices/PowerShellEditorServices.csproj

@@ -13,9 +13,16 @@
     <FileAlignment>512</FileAlignment>
     <SolutionDir Condition="$(SolutionDir) == '' Or $(SolutionDir) == '*Undefined*'">..\..\</SolutionDir>
     <RestorePackages>true</RestorePackages>
-    <DefineConstants Condition=" '$(PowerShellVersion)' == 'v3'">PowerShellv3</DefineConstants>
-    <DefineConstants Condition=" '$(PowerShellVersion)' == 'v4'">PowerShellv4</DefineConstants>
-    <DefineConstants Condition=" '$(PowerShellVersion)' == '' Or '$(PowerShellVersion)' == 'v5'">PowerShellv5</DefineConstants>
+    <DefineConstants Condition="'$(PowerShellVersion)' == 'v3'">$(DefineConstants);PowerShellv3</DefineConstants>
+    <DefineConstants Condition="'$(PowerShellVersion)' == 'v4'">$(DefineConstants);PowerShellv4</DefineConstants>
+    <!-- NOTE: -->
+    <!-- For PowerShell v5 there are some differences between the APIs released with -->
+    <!-- Windows 10 RTM and Windows 10 Update 1, thus we need to distinguish between -->
+    <!-- the two in our code.  v5r1 indicates Win 10 RTM (10240) and v5r2 indicates  -->
+    <!-- Win10 Update 1 (10586).  The PowerShellv5 constant will be defined for both -->
+    <!-- of these versions for anything that should work against both APIs.          -->
+    <DefineConstants Condition="'$(PowerShellVersion)' == 'v5r1'">$(DefineConstants);PowerShellv5r1;PowerShellv5</DefineConstants>
+    <DefineConstants Condition="'$(PowerShellVersion)' == 'v5r2' Or '$(PowerShellVersion)' == ''">$(DefineConstants);PowerShellv5r2;PowerShellv5</DefineConstants>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>

src/PowerShellEditorServices/Session/EditorSession.cs

@@ -60,9 +60,6 @@ public class EditorSession
         /// </summary>
         public void StartSession()
         {
-            // Create a workspace to contain open files
-            this.Workspace = new Workspace();
-
             // Initialize all services
             this.PowerShellContext = new PowerShellContext();
             this.LanguageService = new LanguageService(this.PowerShellContext);
@@ -81,6 +78,9 @@ public void StartSession()
                     LogLevel.Warning,
                     "Script Analyzer binaries not found, AnalysisService will be disabled.");
             }
+
+            // Create a workspace to contain open files
+            this.Workspace = new Workspace(this.PowerShellContext.PowerShellVersion);
         }
 
         #endregion

src/PowerShellEditorServices/Workspace/ScriptFile.cs

@@ -21,6 +21,7 @@ public class ScriptFile
         #region Private Fields
 
         private Token[] scriptTokens;
+        private Version powerShellVersion;
 
         #endregion
 
@@ -126,12 +127,18 @@ public string[] ReferencedFiles
         /// <param name="filePath">The path at which the script file resides.</param>
         /// <param name="clientFilePath">The path which the client uses to identify the file.</param>
         /// <param name="textReader">The TextReader to use for reading the file's contents.</param>
-        public ScriptFile(string filePath, string clientFilePath, TextReader textReader)
+        /// <param name="powerShellVersion">The version of PowerShell for which the script is being parsed.</param>
+        public ScriptFile(
+            string filePath,
+            string clientFilePath,
+            TextReader textReader,
+            Version powerShellVersion)
         {
             this.FilePath = filePath;
             this.ClientFilePath = clientFilePath;
             this.IsAnalysisEnabled = true;
             this.IsInMemory = Workspace.IsPathInMemory(filePath);
+            this.powerShellVersion = powerShellVersion;
 
             this.SetFileContents(textReader.ReadToEnd());
         }
@@ -142,11 +149,17 @@ public ScriptFile(string filePath, string clientFilePath, TextReader textReader)
         /// <param name="filePath">The path at which the script file resides.</param>
         /// <param name="clientFilePath">The path which the client uses to identify the file.</param>
         /// <param name="initialBuffer">The initial contents of the script file.</param>
-        public ScriptFile(string filePath, string clientFilePath, string initialBuffer)
+        /// <param name="powerShellVersion">The version of PowerShell for which the script is being parsed.</param>
+        public ScriptFile(
+            string filePath,
+            string clientFilePath,
+            string initialBuffer,
+            Version powerShellVersion)
         {
             this.FilePath = filePath;
             this.ClientFilePath = clientFilePath;
             this.IsAnalysisEnabled = true;
+            this.powerShellVersion = powerShellVersion;
 
             this.SetFileContents(initialBuffer);
         }
@@ -358,15 +371,39 @@ private void ParseFileContents()
 
             try
             {
+#if PowerShellv5r2
+                // This overload appeared with Windows 10 Update 1
+                if (this.powerShellVersion.Major >= 5 &&
+                    this.powerShellVersion.Build >= 10586)
+                {
+                    // Include the file path so that module relative
+                    // paths are evaluated correctly
+                    this.ScriptAst =
+                        Parser.ParseInput(
+                            this.Contents,
+                            this.FilePath,
+                            out this.scriptTokens,
+                            out parseErrors);
+                }
+                else
+                {
+                    this.ScriptAst =
+                        Parser.ParseInput(
+                            this.Contents,
+                            out this.scriptTokens,
+                            out parseErrors);
+                }
+#else
                 this.ScriptAst =
                     Parser.ParseInput(
-                        this.Contents, 
-                        out this.scriptTokens, 
+                        this.Contents,
+                        out this.scriptTokens,
                         out parseErrors);
+#endif
             }
             catch (RuntimeException ex)
             {
-                var parseError = 
+                var parseError =
                     new ParseError(
                         null,
                         ex.ErrorRecord.FullyQualifiedErrorId, 
@@ -388,6 +425,6 @@ private void ParseFileContents()
                 AstOperations.FindDotSourcedIncludes(this.ScriptAst);
         }
 
-        #endregion
+#endregion
     }
 }

src/PowerShellEditorServices/Workspace/Workspace.cs

@@ -20,6 +20,7 @@ public class Workspace
     {
         #region Private Fields
 
+        private Version powerShellVersion;
         private Dictionary<string, ScriptFile> workspaceFiles = new Dictionary<string, ScriptFile>();
 
         #endregion
@@ -33,6 +34,19 @@ public class Workspace
 
         #endregion
 
+        #region Constructors
+
+        /// <summary>
+        /// Creates a new instance of the Workspace class.
+        /// </summary>
+        /// <param name="powerShellVersion">The version of PowerShell for which scripts will be parsed.</param>
+        public Workspace(Version powerShellVersion)
+        {
+            this.powerShellVersion = powerShellVersion;
+        }
+
+        #endregion
+
         #region Public Methods
 
         /// <summary>
@@ -63,7 +77,13 @@ public ScriptFile GetFile(string filePath)
 
                 using (StreamReader streamReader = new StreamReader(resolvedFilePath, Encoding.UTF8))
                 {
-                    scriptFile = new ScriptFile(resolvedFilePath, filePath, streamReader);
+                    scriptFile = 
+                        new ScriptFile(
+                            resolvedFilePath,
+                            filePath,
+                            streamReader,
+                            this.powerShellVersion);
+
                     this.workspaceFiles.Add(keyName, scriptFile);
                 }
 
@@ -92,7 +112,13 @@ public ScriptFile GetFileBuffer(string filePath, string initialBuffer)
             ScriptFile scriptFile = null;
             if (!this.workspaceFiles.TryGetValue(keyName, out scriptFile))
             {
-                scriptFile = new ScriptFile(resolvedFilePath, filePath, initialBuffer);
+                scriptFile = 
+                    new ScriptFile(
+                        resolvedFilePath,
+                        filePath,
+                        initialBuffer,
+                        this.powerShellVersion);
+
                 this.workspaceFiles.Add(keyName, scriptFile);
 
                 Logger.Write(LogLevel.Verbose, "Opened file as in-memory buffer: " + resolvedFilePath);

test/PowerShellEditorServices.Test.Host/LanguageServerTests.cs

@@ -81,6 +81,21 @@ await this.WaitForEvent(
             Assert.Contains("unapproved", diagnostics.Diagnostics[0].Message);
         }
 
+        [Fact]
+        public async Task ServiceReturnsNoErrorsForUsingRelativeModulePaths()
+        {
+            // Send the 'didOpen' event
+            await this.SendOpenFileEvent("TestFiles\\Module.psm1", false);
+
+            // Wait for the diagnostic event
+            PublishDiagnosticsNotification diagnostics = 
+                await this.WaitForEvent(
+                    PublishDiagnosticsNotification.Type);
+
+            // Was there a syntax error?
+            Assert.Equal(0, diagnostics.Diagnostics.Length);
+        }
+
         [Fact]
         public async Task ServiceCompletesFunctionName()
         {

test/PowerShellEditorServices.Test.Host/PowerShellEditorServices.Test.Host.csproj

@@ -74,12 +74,18 @@
   <ItemGroup>
     <None Include="App.config" />
     <None Include="packages.config" />
+    <None Include="TestFiles\ChildModule\ChildModule.psm1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Include="TestFiles\CompleteFunctionName.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
     <None Include="TestFiles\FindReferences.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Include="TestFiles\Module.psm1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Include="TestFiles\MultiLineReplace.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

test/PowerShellEditorServices.Test.Host/TestFiles/ChildModule/ChildModule.psm1

@@ -0,0 +1,2 @@
+function Get-Stuff {
+}

test/PowerShellEditorServices.Test.Host/TestFiles/Module.psm1

@@ -0,0 +1 @@
+using module ".\ChildModule"

test/PowerShellEditorServices.Test/Debugging/DebugServiceTests.cs

@@ -30,7 +30,10 @@ public class DebugServiceTests : IDisposable
 
         public DebugServiceTests()
         {
-            this.workspace = new Workspace();
+            this.powerShellContext = new PowerShellContext();
+            this.powerShellContext.SessionStateChanged += powerShellContext_SessionStateChanged;
+
+            this.workspace = new Workspace(this.powerShellContext.PowerShellVersion);
 
             // Load the test debug file
             this.debugScriptFile =
@@ -41,13 +44,15 @@ public DebugServiceTests()
                 this.workspace.GetFile(
                     @"..\..\..\PowerShellEditorServices.Test.Shared\Debugging\VariableTest.ps1");
 
-            this.powerShellContext = new PowerShellContext();
-            this.powerShellContext.SessionStateChanged += powerShellContext_SessionStateChanged;
-
             this.debugService = new DebugService(this.powerShellContext);
             this.debugService.DebuggerStopped += debugService_DebuggerStopped;
             this.debugService.BreakpointUpdated += debugService_BreakpointUpdated;
             this.runnerContext = SynchronizationContext.Current;
+
+            // Load the test debug file
+            this.debugScriptFile =
+                this.workspace.GetFile(
+                    @"..\..\..\PowerShellEditorServices.Test.Shared\Debugging\DebugTest.ps1");
         }
 
         async void powerShellContext_SessionStateChanged(object sender, SessionStateChangedEventArgs e)

test/PowerShellEditorServices.Test/Language/LanguageServiceTests.cs

@@ -32,9 +32,8 @@ public class LanguageServiceTests : IDisposable
 
         public LanguageServiceTests()
         {
-            this.workspace = new Workspace();
-
             this.powerShellContext = new PowerShellContext();
+            this.workspace = new Workspace(this.powerShellContext.PowerShellVersion);
             this.languageService = new LanguageService(this.powerShellContext);
         }
 

test/PowerShellEditorServices.Test/Language/PowerShellVersionTests.cs

@@ -16,10 +16,10 @@ namespace Microsoft.PowerShell.EditorServices.Test.Language
     public class PowerShellVersionTests 
     {
         [Theory]
-        [InlineData("3")]
-        [InlineData("4")]
-        [InlineData("5")]
-        public void CompilesWithPowerShellVersion(string version)
+        [InlineData("3", "4")]
+        [InlineData("4", "4")]
+        [InlineData("5", "5r1")]
+        public void CompilesWithPowerShellVersion(string version, string versionSuffix)
         {
             var assemblyPath = 
                 Path.GetFullPath(
@@ -40,15 +40,15 @@ public void CompilesWithPowerShellVersion(string version)
 
             try
             {
-                Compile(projectVersion, version);
+                Compile(projectVersion, version, versionSuffix);
             }
             finally
             {
                 File.Delete(projectVersion);
             }
         }
 
-        private void Compile(string project, string version)
+        private void Compile(string project, string version, string versionSuffix)
         {
             string msbuild;
             using (var key = Registry.LocalMachine.OpenSubKey(@"SOFTWARE\Microsoft\MSBuild\ToolsVersions\14.0"))

test/PowerShellEditorServices.Test/Session/ScriptFileTests.cs

@@ -4,13 +4,16 @@
 //
 
 using Microsoft.PowerShell.EditorServices;
+using System;
 using System.IO;
 using Xunit;
 
 namespace PSLanguageService.Test
 {
     public class FileChangeTests
     {
+        private static readonly Version PowerShellVersion = new Version("5.0"); 
+
         [Fact]
         public void CanApplySingleLineInsert()
         {
@@ -135,7 +138,13 @@ public void FindsDotSourcedFiles()
 
             using (StringReader stringReader = new StringReader(exampleScriptContents))
             {
-                ScriptFile scriptFile = new ScriptFile("DotSourceTestFile.ps1", "DotSourceTestFile.ps1", stringReader);
+                ScriptFile scriptFile = 
+                    new ScriptFile(
+                        "DotSourceTestFile.ps1",
+                        "DotSourceTestFile.ps1",
+                        stringReader,
+                        PowerShellVersion);
+
                 Assert.Equal(3, scriptFile.ReferencedFiles.Length);
                 System.Console.Write("a" + scriptFile.ReferencedFiles[0]);
                 Assert.Equal(@".\athing.ps1", scriptFile.ReferencedFiles[0]);
@@ -150,7 +159,12 @@ private void AssertFileChange(
             using (StringReader stringReader = new StringReader(initialString))
             {
                 // Create an in-memory file from the StringReader
-                ScriptFile fileToChange = new ScriptFile("TestFile.ps1", "TestFile.ps1", stringReader);
+                ScriptFile fileToChange = 
+                    new ScriptFile(
+                        "TestFile.ps1",
+                        "TestFile.ps1",
+                        stringReader,
+                        PowerShellVersion);
 
                 // Apply the FileChange and assert the resulting contents
                 fileToChange.ApplyChange(fileChange);