Skip to content

Change to not expose unsupported aliases/cmdlets in Unix #3595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 14 commits into from
May 23, 2017
Merged

Change to not expose unsupported aliases/cmdlets in Unix #3595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
8ee5bf0
Remove 'gin' alias on Unix
iSazonov Apr 19, 2017
501e2f0
Fix aliases
iSazonov Apr 20, 2017
9dc9ab8
Move aliases to InitialSessionState.cs
iSazonov Apr 25, 2017
113e43b
Remove unneeded tests
iSazonov May 15, 2017
609649b
Add comment
iSazonov May 15, 2017
b40f5a1
Remove if/def CORECLR
iSazonov May 16, 2017
f59b878
Move new aliases to modules
iSazonov May 16, 2017
6ea3980
Fix [Alias ("fhx")]
iSazonov May 17, 2017
790ba5a
Remove 'cfs' alias
iSazonov May 17, 2017
b74d04c
Remove comment
iSazonov May 17, 2017
8f4aaff
Remove unneeded alias test
iSazonov May 17, 2017
158cb3b
Fix changes in .psd1 files
iSazonov May 18, 2017
705d3de
Add checks for alias options and minor refactoring
iSazonov May 18, 2017
3bba7ae
Remove duplicated alias tests
iSazonov May 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Microsoft.PowerShell.Commands.Management/commands/management/GetClipboardCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,4 +199,4 @@ private PSObject WrapOutputInPSObject(
return result;
}
}
}
}
4 changes: 4 additions & 0 deletions src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Copyright (c) Microsoft Corporation. All rights reserved.
--********************************************************************/

#if !UNIX

using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
Expand Down Expand Up @@ -5179,3 +5181,5 @@ private static class PInvokeDllNames
}
#endregion Native
}

#endif
2 changes: 1 addition & 1 deletion src/Microsoft.PowerShell.Commands.Management/commands/management/SetClipboardCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,4 +417,4 @@ private static int GetByteCount(StringBuilder sb, int start = 0, int end = -1)
return count;
}
}
}
}
2 changes: 1 addition & 1 deletion ...oft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/format-hex/Format-Hex.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ namespace Microsoft.PowerShell.Commands
/// Displays the hexidecimal equivalent of the input data.
/// </summary>
[Cmdlet(VerbsCommon.Format, "Hex", SupportsShouldProcess = true, HelpUri ="https://go.microsoft.com/fwlink/?LinkId=526919")]
[Alias ("fhx")]
Copy link
Member

@daxian-dbw daxian-dbw May 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alias declaration shouldn't be removed.

Copy link
Collaborator Author

@iSazonov iSazonov May 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, sorry. Fixed.

[OutputType(typeof(Microsoft.PowerShell.Commands.ByteCollection))]
[Alias ("fhx")]
public sealed class FormatHex : PSCmdlet
{
private const int BUFFERSIZE = 16;
Expand Down
1 change: 1 addition & 0 deletions src/Modules/Unix/Microsoft.PowerShell.Management/Microsoft.PowerShell.Management.psd1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ ModuleVersion="3.1.0.0"
PowerShellVersion="3.0"
NestedModules="Microsoft.PowerShell.Commands.Management.dll"
HelpInfoURI = 'https://go.microsoft.com/fwlink/?linkid=390785'
AliasesToExport = @("gtz")
FunctionsToExport = @()
CmdletsToExport=@("Add-Content",
"Clear-Content",
Expand Down
2 changes: 1 addition & 1 deletion ...Modules/Windows-Core/Microsoft.PowerShell.Management/Microsoft.PowerShell.Management.psd1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ModuleVersion="3.1.0.0"
PowerShellVersion="3.0"
NestedModules="Microsoft.PowerShell.Commands.Management.dll"
HelpInfoURI = 'https://go.microsoft.com/fwlink/?linkid=390785'
AliasesToExport = @("gin", "gtz", "stz")
Copy link
Member

@daxian-dbw daxian-dbw May 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be removed.

Copy link
Collaborator Author

@iSazonov iSazonov May 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same - we now control all the aliases in the tests and can safely export all aliases by default.

Copy link
Member

@daxian-dbw daxian-dbw May 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same reason as explained above.

Copy link
Collaborator Author

@iSazonov iSazonov May 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

AliasesToExport = @("gin", "gtz", "stz")
FunctionsToExport = @()
CmdletsToExport=@("Add-Content",
"Clear-Content",
Expand Down
16 changes: 10 additions & 6 deletions src/System.Management.Automation/engine/InitialSessionState.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5054,8 +5054,6 @@ internal static SessionStateAliasEntry[] BuiltInAliases
"Get-Process", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("group",
"Group-Object", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("gsv",
"Get-Service", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("gu",
"Get-Unique", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("gv",
Expand Down Expand Up @@ -5110,8 +5108,6 @@ internal static SessionStateAliasEntry[] BuiltInAliases
"Resolve-Path", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("sal",
"Set-Alias", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("sasv",
"Start-Service", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("sbp",
"Set-PSBreakpoint", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("sc",
Expand All @@ -5131,8 +5127,6 @@ internal static SessionStateAliasEntry[] BuiltInAliases
"Start-Process", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("spps",
"Stop-Process", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("spsv",
"Stop-Service", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("sv",
"Set-Variable", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
// Web cmdlets aliases
Expand All @@ -5151,12 +5145,18 @@ internal static SessionStateAliasEntry[] BuiltInAliases
"Copy-ItemProperty", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("diff",
"Compare-Object", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("gsv",
"Get-Service", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("sleep",
"Start-Sleep", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("sort",
"Sort-Object", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("start",
"Start-Process", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("sasv",
"Start-Service", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("spsv",
"Stop-Service", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("tee",
"Tee-Object", "", ScopedItemOptions.ReadOnly | ScopedItemOptions.AllScope),
new SessionStateAliasEntry("write",
Expand Down Expand Up @@ -5883,6 +5883,10 @@ private static void AnalyzeModuleAssemblyWithReflection(Assembly assembly, strin
var aliasList = new List<SessionStateAliasEntry>();
foreach (var alias in aliasAttribute.AliasNames)
{
// Alias declared by AliasAttribute is set with the option 'ScopedItemOptions.None',
// because we believe a user of the cmdlet, instead of the author of it,
// should be the one to decide the option
// ('ScopedItemOptions.ReadOnly' and/or 'ScopedItemOptions.AllScopes') of the alias usage."
Copy link
Member

@daxian-dbw daxian-dbw May 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment probably should be removed now. When making the change to add internal support to AliasAttribute to allow specifying options, we can have a more accurate comment here.

Copy link
Collaborator Author

@iSazonov iSazonov May 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Today the comment is correct. After improving the AliasAttribute the code here will be changed too and we could adjust the comment in that time.

Copy link
Member

@daxian-dbw daxian-dbw May 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's reasonable #closed

var aliasEntry = new SessionStateAliasEntry(alias, cmdletName, "", ScopedItemOptions.None);
if (psSnapInInfo != null)
{
Expand Down
5 changes: 0 additions & 5 deletions test/powershell/Modules/Microsoft.PowerShell.Management/Get-ComputerInfo.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1332,11 +1332,6 @@ try {
}
}

It "Verify that alias 'gin' exists" {
Copy link
Member

@mirichmo mirichmo Apr 20, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than removing this test, can you skip it for non-windows platforms?

Copy link
Collaborator Author

@iSazonov iSazonov Apr 20, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea (from @lzybkr) is that we should put all alias tests in one place (Default-Aliases.Tests.ps1) rather than spread on many files.

$result = (Get-Alias -Name "gin").Name
$result | Should Be "gin"
}

It "Test for DeviceGuard properties" {
if (-not (HasDeviceGuardLicense))
{
Expand Down
8 changes: 0 additions & 8 deletions test/powershell/Modules/Microsoft.PowerShell.Management/TimeZone.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,6 @@ Describe "Get-Timezone test cases" -Tags "CI" {
Assert-ListsSame $expectedIdList $result
}

It "Verify that alias 'gtz' exists" {
(Get-Alias -Name "gtz").Name | Should Be "gtz"
}

It "Call Get-TimeZone Name parameter from pipeline by value " {
$result = ("Pacific*" | Get-TimeZone).Id
$expectedIdList = ($TimeZonesAvailable | Where-Object { $_.StandardName -match "^Pacific" }).Id
Expand Down Expand Up @@ -211,10 +207,6 @@ try {
}
}

It "Verify that alias 'stz' exists" {
(Get-Alias -Name "stz").Name | Should Be "stz"
}

It "Call Set-TimeZone from pipeline input object of type TimeZoneInfo" {
$origTimeZoneID = (Get-TimeZone).Id
$timezoneList = Get-TimeZone -ListAvailable
Expand Down
6 changes: 0 additions & 6 deletions test/powershell/Modules/Microsoft.PowerShell.Utility/Clear-Variable.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,6 @@ Describe "Clear-Variable" -Tags "CI" {
{ Get-Variable var1 } | Should Not Throw
}

It "Should work using the clv alias" {
clv -Name var1
$var1 | Should BeNullOrEmpty
{ Get-Variable var1 } | Should Not Throw
}
Copy link
Member

@daxian-dbw daxian-dbw May 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is not checking if the alias exists, but actually testing the functionality of clear-variable, so it shouldn't be removed.

Copy link
Collaborator Author

@iSazonov iSazonov May 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous test do that so the test is alias related only.

Copy link
Member

@daxian-dbw daxian-dbw May 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#Closed.


It "Should be able to include a set of variables to clear" {
$var1 = 2
$var2 = 3
Expand Down
Loading