Merge internal/Az.Tools.Predictor

.azure-pipelines/sign-tool-predictor.yml

@@ -0,0 +1,93 @@
+pr: none
+trigger: none
+pool:
+  vmImage: 'windows-2019'
+
+steps:
+- task: PowerShell@2
+  displayName: Install PS 7.1.0-preview.7
+  inputs:
+    targetType: 'inline'
+    script: |
+      $url = "https://github.com/PowerShell/PowerShell/releases/download/v7.1.0-preview.7/PowerShell-7.1.0-preview.7-win-x64.zip"
+      $output = Join-Path -Path $(Pipeline.Workspace) -ChildPath "./PowerShell-7.1.0-preview.7-win-x64.zip"
+      (New-Object System.Net.WebClient).DownloadFile($url, $output)
+      $pwshPath= Join-Path -Path $(Pipeline.Workspace) -ChildPath "./PowerShell-7.1.0-preview.7/"
+      Expand-Archive -Path $output -DestinationPath $pwshPath
+      $pwshFullPath = Convert-Path $pwshPath
+      Write-Host $pwshFullPath
+
+- task: PowerShell@2
+  displayName: 'Install platyPS, PowerShellGet, Az 3.0.0'
+  inputs:
+    targetType: inline
+    script: |
+      $pwshPath= Join-Path -Path $(Pipeline.Workspace) -ChildPath "./PowerShell-7.1.0-preview.7/pwsh.exe"        
+      $command = "`$PSVersionTable `
+        Install-Module platyPS -Force -Confirm:`$false -Scope CurrentUser `
+        Install-Module PowerShellGet -Force -Confirm:`$false -Scope CurrentUser -SkipPublisherCheck `
+        Install-Module Az -Repository PSGallery -RequiredVersion 3.0.0 -Confirm:`$false -Scope CurrentUser -AllowClobber -Force"      
+      Invoke-Command -ScriptBlock { param ($pwshPath, $command) & $pwshPath -Command $command } -ArgumentList $pwshPath, $command 
+
+- task: UseDotNet@2
+  displayName: 'Use .NET Core sdk'
+  inputs:
+    packageType: sdk
+    version: 5.0.100-rc.1.20452.10
+
+- task: DotNetCoreCLI@2
+  displayName: 'Build'
+  inputs:
+    command: custom
+    custom: msbuild
+    arguments: 'tools\Az.Tools.Predictor\build.proj /target:"Clean;Build" /p:Configuration=Release'
+
+- task: EsrpCodeSigning@1
+  displayName: 'Signing'
+  inputs:
+    ConnectedServiceName: $(signServiceConnection)
+    FolderPath: artifacts
+    Pattern: |
+     Tools/**/*.ps1
+     Tools/**/*.psd1
+     Tools/**/*.psm1
+     Tools/**/*.ps1xml
+    UseMinimatch: true
+    signConfigType: inlineSignParams
+    inlineOperation: |
+     [
+       {
+         "KeyCode": "CP-230012",
+         "OperationCode": "SigntoolSign",
+         "Parameters": {
+           "OpusName": "Microsoft",
+           "OpusInfo": "http://www.microsoft.com",
+           "FileDigest": "/fd \"SHA256\"",
+           "PageHash": "/NPH",
+           "TimeStamp": "/tr \"http://rfc3161.gtm.corp.microsoft.com/TSS/HttpTspServer\" /td sha256"
+         },
+         "ToolName": "sign",
+         "ToolVersion": "1.0"
+       },
+       {
+         "KeyCode": "CP-230012",
+         "OperationCode": "SigntoolVerify",
+         "Parameters": {},
+         "ToolName": "sign",
+         "ToolVersion": "1.0"
+       }
+     ]
+
+- task: DotNetCoreCLI@2
+  displayName: Package
+  inputs:
+    command: custom
+    custom: msbuild
+    arguments: 'tools\Az.Tools.Predictor\build.proj /target:"Package" /p:Configuration=Release /p:PowerShellCoreCommandPrefix="$(Pipeline.Workspace)\\PowerShell-7.1.0-preview.7\\pwsh.exe -NonInteractive -NoLogo -NoProfile -Command" '
+
+- task: PublishPipelineArtifact@0
+  displayName: 'Save artifacts'
+  inputs:
+    artifactName: artifacts
+    targetPath: artifacts
+  condition: succeededOrFailed()

tools/Az.Tools.Installer/build.proj

@@ -29,6 +29,6 @@
 
   <Target Name="Package">
     <Message Text="Package $(ModuleName)" />
-    <Exec Command="$(PowerShellCoreCommandPrefix) &quot;$(RepoTools)\PublishToolsModule.ps1 -RepositoryLocation $(ArtifactFolder) -ModuleName $(ModuleName)&quot;" />
+    <Exec Command="$(PowerShellCoreCommandPrefix) &quot;$(RepoTools)\PublishToolsModule.ps1 -RepositoryLocation $(ArtifactFolder) -PublishLocation $(ArtifactFolder) -ModuleName $(ModuleName)&quot;" />
   </Target>
-</Project>
+</Project>

tools/Az.Tools.Predictor/Az.Tools.Predictor.Test/Az.Tools.Predictor.Test.csproj

@@ -0,0 +1,36 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net5.0</TargetFramework>
+    <AssemblyName>Microsoft.Azure.PowerShell.Tools.AzPredictor.Test</AssemblyName>
+    <RootNamespace>Microsoft.Azure.PowerShell.Tools.AzPredictor.Test</RootNamespace>
+    <IsPackable>false</IsPackable>
+    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+    <RepoArtifacts>$(MSBuildThisFileDirectory)</RepoArtifacts>
+    <OutputPath>$(RepoArtifacts)..\..\..\artifacts\Tools\Az.Tools.Predictor.Test\</OutputPath>
+    <DocumentationFile>$(OutputPath)\Microsoft.Azure.PowerShell.AzPredictor.Tools.Test.xml</DocumentationFile>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="System.Management.Automation" Version="7.1.0-preview.7" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="coverlet.collector" Version="1.3.0">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <ProjectReference Include="..\Az.Tools.Predictor\Az.Tools.Predictor.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="Data\CommandsModel.zip" CopyToOutputDirectory="PreserveNewest" />
+    <None Include="Data\PredictionsModel.zip" CopyToOutputDirectory="PreserveNewest" />
+  </ItemGroup>
+
+</Project>

tools/Az.Tools.Predictor/Az.Tools.Predictor.Test/AzPredictorServiceTests.cs

@@ -0,0 +1,108 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using Microsoft.Azure.PowerShell.Tools.AzPredictor.Test.Mocks;
+using System.Linq;
+using System.Management.Automation.Subsystem;
+using System.Threading;
+using Xunit;
+
+namespace Microsoft.Azure.PowerShell.Tools.AzPredictor.Test
+{
+    /// <summary>
+    /// Tests for <see cref="AzPredictorService"/>
+    /// </summary>
+    [Collection("Model collection")]
+    public class AzPredictorServiceTests
+    {
+        private readonly ModelFixture _fixture;
+        private readonly AzPredictorService _service;
+        private readonly Predictor _suggestionsPredictor;
+        private readonly Predictor _commandsPredictor;
+
+        /// <summary>
+        /// Constructs a new instance of <see cref="AzPredictorServiceTests"/>
+        /// </summary>
+        /// <param name="fixture"></param>
+        public AzPredictorServiceTests(ModelFixture fixture)
+        {
+            this._fixture = fixture;
+            var startHistory = $"{AzPredictorConstants.CommandPlaceholder}{AzPredictorConstants.CommandConcatenator}{AzPredictorConstants.CommandPlaceholder}";
+            this._suggestionsPredictor = new Predictor(this._fixture.PredictionCollection[startHistory], null);
+            this._commandsPredictor = new Predictor(this._fixture.CommandCollection, null);
+
+            this._service = new MockAzPredictorService(startHistory, this._fixture.PredictionCollection[startHistory], this._fixture.CommandCollection);
+        }
+
+
+        /// <summary>
+        /// Verifies that the prediction comes from the suggestions list, not the command list.
+        /// </summary>
+        [Theory]
+        [InlineData("CONNECT-AZACCOUNT")]
+        [InlineData("set-azstorageaccount ")]
+        [InlineData("Get-AzResourceG")]
+        [InlineData("Get-AzStorageAcco")]
+        [InlineData("Get-AzKeyVault -VaultName")]
+        [InlineData("GET-AZSTORAGEACCOUNTKEY -NAME ")]
+        [InlineData("new-azresourcegroup -name hello")]
+        [InlineData("Get-AzContext -Name")]
+        [InlineData("Get-AzContext -ErrorAction")]
+        public void VerifyUsingSuggestion(string userInput)
+        {
+            var predictionContext = PredictionContext.Create(userInput);
+            var expected = this._suggestionsPredictor.Query(predictionContext.InputAst, 1, CancellationToken.None);
+            var actual = this._service.GetSuggestion(predictionContext.InputAst, 1, CancellationToken.None);
+            Assert.NotEmpty(actual);
+            Assert.NotNull(actual.First().Item1);
+            Assert.Equal(expected.First().Key, actual.First().Item1);
+            Assert.Equal(PredictionSource.CurrentCommand, actual.First().Item3);
+        }
+
+        /// <summary>
+        /// Verifies that when no prediction is in the suggestion list, we'll use the command list.
+        /// </summary>
+        [Theory]
+        [InlineData("Get-AzResource -Name hello -Pre")]
+        [InlineData("Get-AzADServicePrincipal -ApplicationObject")]
+        public void VerifyUsingCommand(string userInput)
+        {
+            var predictionContext = PredictionContext.Create(userInput);
+            var expected = this._commandsPredictor.Query(predictionContext.InputAst, 1, CancellationToken.None);
+            var actual = this._service.GetSuggestion(predictionContext.InputAst, 1, CancellationToken.None);
+            Assert.NotEmpty(actual);
+            Assert.NotNull(actual.First().Item1);
+            Assert.Equal(expected.First().Key, actual.First().Item1);
+            Assert.Equal(PredictionSource.StaticCommands, actual.First().Item3);
+        }
+
+        /// <summary>
+        /// Verify that no prediction for the user input, meaning it's not in the prediction list or the command list.
+        /// </summary>
+        [Theory]
+        [InlineData(AzPredictorConstants.CommandPlaceholder)]
+        [InlineData("git status")]
+        [InlineData("Get-ChildItem")]
+        [InlineData("new-azresourcegroup -NoExistingParam")]
+        [InlineData("get-azaccount ")]
+        [InlineData("Get-AzContext Name")]
+        [InlineData("NEW-AZCONTEXT")]
+        public void VerifyNoPrediction(string userInput)
+        {
+            var predictionContext = PredictionContext.Create(userInput);
+            var actual = this._service.GetSuggestion(predictionContext.InputAst, 1, CancellationToken.None);
+            Assert.Empty(actual);
+        }
+    }
+}