Skip to content

Commit b754cd8

Browse files
faraazahmadiSazonov
faraazahmad
authored and
iSazonov
committed
Throw error on entering non-existing type in Get-FormatData (#7434)
Write non-terminating error when `Get-FormatData` doesn't found a type definition for the provided type,
1 parent 037e12e commit b754cd8

File tree

3 files changed

+161
-18
lines changed

3 files changed

+161
-18
lines changed

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/common/GetFormatDataCommand.cs‎

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
// Licensed under the MIT License.
33

44
using System;
5-
using System.Linq;
6-
using System.Management.Automation;
75
using System.Collections.Generic;
86
using System.Diagnostics.CodeAnalysis;
7+
using System.Linq;
8+
using System.Management.Automation;
9+
using System.Management.Automation.Internal;
910
using System.Management.Automation.Runspaces;
1011
using Microsoft.PowerShell.Commands.Internal.Format;
1112

@@ -167,29 +168,40 @@ protected override void ProcessRecord()
167168
typedefs.Add(consolidatedTypeName, viewList);
168169
}
169170
viewList.Add(formatdef);
170-
}// foreach(ViewDefinition...
171+
}
171172

172-
// write out all the available type definitions
173-
foreach (var pair in typedefs)
173+
if (typedefs.Count == 0)
174174
{
175-
var typeNames = pair.Key;
176-
177-
if (writeOldWay)
175+
ErrorRecord errorRecord = new ErrorRecord(
176+
new TypeLoadException(StringUtil.Format(GetFormatDataStrings.SpecifiedTypeNotFound, _typename)),
177+
"SpecifiedTypeNotFound",
178+
ErrorCategory.InvalidOperation,
179+
_typename);
180+
WriteError(errorRecord);
181+
}
182+
else
183+
{
184+
foreach (var pair in typedefs)
178185
{
179-
foreach (var typeName in typeNames)
186+
var typeNames = pair.Key;
187+
188+
if (writeOldWay)
180189
{
181-
var etd = new ExtendedTypeDefinition(typeName, pair.Value);
182-
WriteObject(etd);
190+
foreach (var typeName in typeNames)
191+
{
192+
var etd = new ExtendedTypeDefinition(typeName, pair.Value);
193+
WriteObject(etd);
194+
}
183195
}
184-
}
185-
else
186-
{
187-
var etd = new ExtendedTypeDefinition(typeNames[0], pair.Value);
188-
for (int i = 1; i < typeNames.Count; i++)
196+
else
189197
{
190-
etd.TypeNames.Add(typeNames[i]);
198+
var etd = new ExtendedTypeDefinition(typeNames[0], pair.Value);
199+
for (int i = 1; i < typeNames.Count; i++)
200+
{
201+
etd.TypeNames.Add(typeNames[i]);
202+
}
203+
WriteObject(etd);
191204
}
192-
WriteObject(etd);
193205
}
194206
}
195207
}

‎src/Microsoft.PowerShell.Commands.Utility/resources/GetFormatDataStrings.resx‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="https://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="SpecifiedTypeNotFound" xml:space="preserve">
121+
<value>The type name '{0}' could not be found.</value>
122+
</data>
123+
</root>

‎test/powershell/Modules/Microsoft.PowerShell.Utility/Get-FormatData.Tests.ps1‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Copyright (c) Microsoft Corporation. All rights reserved.
22
# Licensed under the MIT License.
3+
34
Describe "Get-FormatData" -Tags "CI" {
45

56
Context "Check return type of Get-FormatData" {
@@ -9,4 +10,11 @@ Describe "Get-FormatData" -Tags "CI" {
910
,$result | Should -BeOfType "System.Object[]"
1011
}
1112
}
13+
14+
Context "Check for error on invalid type as argument" {
15+
16+
It "Should throw error on invalid type as argument" {
17+
{ Get-FormatData "NoSuch.Type.Exists.Or.IsLoaded" -ErrorAction Stop } | Should -Throw -ErrorId "SpecifiedTypeNotFound,Microsoft.PowerShell.Commands.GetFormatDataCommand"
18+
}
19+
}
1220
}

0 commit comments

Comments
 (0)