File size: 13,522 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#region Using directives
using System;
using System.Management.Automation;
#endregion
namespace Microsoft.Management.Infrastructure.CimCmdlets
{
/// <summary>
/// <para>
/// Wrapper of Cmdlet, forward the operation to Cmdlet directly.
/// This is for unit test purpose, unit test can derive from this class,
/// to hook up all of the cmdlet related operation and verify the correctness.
/// </para>
/// </summary>
internal class CmdletOperationBase
{
/// <summary>
/// <para>
/// Wrap the Cmdlet object.
/// </para>
/// </summary>
private readonly Cmdlet cmdlet;
/// <summary>
/// <para>
/// Wrap the Cmdlet methods, for testing purpose.
/// Test binary can define a child class of CmdletOperationBase.
/// While Execute method of <seealso cref="CimBaseAction"/> accept the
/// object of CmdletOperationBase as parameter.
/// </para>
/// </summary>
#region CMDLET methods
public virtual bool ShouldContinue(string query, string caption)
{
return cmdlet.ShouldContinue(query, caption);
}
public virtual bool ShouldContinue(string query, string caption, ref bool yesToAll, ref bool noToAll)
{
return cmdlet.ShouldContinue(query, caption, ref yesToAll, ref noToAll);
}
public virtual bool ShouldProcess(string target)
{
return cmdlet.ShouldProcess(target);
}
public virtual bool ShouldProcess(string target, string action)
{
return cmdlet.ShouldProcess(target, action);
}
public virtual bool ShouldProcess(string verboseDescription, string verboseWarning, string caption)
{
return cmdlet.ShouldProcess(verboseDescription, verboseWarning, caption);
}
public virtual bool ShouldProcess(string verboseDescription, string verboseWarning, string caption, out ShouldProcessReason shouldProcessReason)
{
return cmdlet.ShouldProcess(verboseDescription, verboseWarning, caption, out shouldProcessReason);
}
[System.Diagnostics.CodeAnalysis.DoesNotReturn]
public virtual void ThrowTerminatingError(ErrorRecord errorRecord)
{
cmdlet.ThrowTerminatingError(errorRecord);
}
public virtual void WriteCommandDetail(string text)
{
cmdlet.WriteCommandDetail(text);
}
public virtual void WriteDebug(string text)
{
cmdlet.WriteDebug(text);
}
public virtual void WriteError(ErrorRecord errorRecord)
{
cmdlet.WriteError(errorRecord);
}
public virtual void WriteObject(object sendToPipeline, XOperationContextBase context)
{
cmdlet.WriteObject(sendToPipeline);
}
public virtual void WriteObject(object sendToPipeline, bool enumerateCollection, XOperationContextBase context)
{
cmdlet.WriteObject(sendToPipeline, enumerateCollection);
}
public virtual void WriteProgress(ProgressRecord progressRecord)
{
cmdlet.WriteProgress(progressRecord);
}
public virtual void WriteVerbose(string text)
{
cmdlet.WriteVerbose(text);
}
public virtual void WriteWarning(string text)
{
cmdlet.WriteWarning(text);
}
/// <summary>
/// <para>
/// Throw terminating error
/// </para>
/// </summary>
[System.Diagnostics.CodeAnalysis.DoesNotReturn]
internal void ThrowTerminatingError(Exception exception, string operation)
{
ErrorRecord errorRecord = new(exception, operation, ErrorCategory.InvalidOperation, this);
cmdlet.ThrowTerminatingError(errorRecord);
}
#endregion
/// <summary>
/// Initializes a new instance of the <see cref="CmdletOperationBase"/> class.
/// </summary>
public CmdletOperationBase(Cmdlet cmdlet)
{
ValidationHelper.ValidateNoNullArgument(cmdlet, "cmdlet");
this.cmdlet = cmdlet;
}
}
#region Class CmdletOperationRemoveCimInstance
/// <summary>
/// <para>
/// Wrapper of Cmdlet, override WriteObject function call since
/// we need to remove <see cref="CimInstance"/>.
/// </para>
/// </summary>
internal class CmdletOperationRemoveCimInstance : CmdletOperationBase
{
/// <summary>
/// Initializes a new instance of the <see cref="CmdletOperationRemoveCimInstance"/> class.
/// </summary>
/// <param name="cmdlet"></param>
public CmdletOperationRemoveCimInstance(Cmdlet cmdlet,
CimRemoveCimInstance cimRemoveCimInstance)
: base(cmdlet)
{
ValidationHelper.ValidateNoNullArgument(cimRemoveCimInstance, cimRemoveCimInstanceParameterName);
this.removeCimInstance = cimRemoveCimInstance;
}
/// <summary>
/// <para>
/// Object here need to be removed if it is CimInstance
/// </para>
/// </summary>
/// <param name="sendToPipeline"></param>
public override void WriteObject(object sendToPipeline, XOperationContextBase context)
{
if (sendToPipeline is CimInstance)
{
DebugHelper.WriteLog(">>>>CmdletOperationRemoveCimInstance::WriteObject", 4);
this.removeCimInstance.RemoveCimInstance(sendToPipeline as CimInstance, context, this);
}
else
{
base.WriteObject(sendToPipeline, context);
}
}
public override void WriteObject(object sendToPipeline, bool enumerateCollection, XOperationContextBase context)
{
if (sendToPipeline is CimInstance)
{
this.WriteObject(sendToPipeline, context);
}
else
{
base.WriteObject(sendToPipeline, enumerateCollection, context);
}
}
#region private methods
private readonly CimRemoveCimInstance removeCimInstance;
private const string cimRemoveCimInstanceParameterName = @"cimRemoveCimInstance";
#endregion
}
#endregion
#region Class CmdletOperationSetCimInstance
/// <summary>
/// <para>
/// Wrapper of Cmdlet, override WriteObject function call since
/// we need to set <see cref="CimInstance"/>.
/// </para>
/// </summary>
internal class CmdletOperationSetCimInstance : CmdletOperationBase
{
/// <summary>
/// Initializes a new instance of the <see cref="CmdletOperationSetCimInstance"/> class.
/// </summary>
/// <param name="cmdlet"></param>
public CmdletOperationSetCimInstance(Cmdlet cmdlet,
CimSetCimInstance theCimSetCimInstance)
: base(cmdlet)
{
ValidationHelper.ValidateNoNullArgument(theCimSetCimInstance, theCimSetCimInstanceParameterName);
this.setCimInstance = theCimSetCimInstance;
}
/// <summary>
/// <para>
/// Object here need to be removed if it is CimInstance
/// </para>
/// </summary>
/// <param name="sendToPipeline"></param>
public override void WriteObject(object sendToPipeline, XOperationContextBase context)
{
DebugHelper.WriteLogEx();
if (sendToPipeline is CimInstance)
{
if (context is CimSetCimInstanceContext setContext)
{
if (string.Equals(setContext.ParameterSetName, CimBaseCommand.QueryComputerSet, StringComparison.OrdinalIgnoreCase) ||
string.Equals(setContext.ParameterSetName, CimBaseCommand.QuerySessionSet, StringComparison.OrdinalIgnoreCase))
{
this.setCimInstance.SetCimInstance(sendToPipeline as CimInstance, setContext, this);
return;
}
else
{
DebugHelper.WriteLog("Write the cimInstance to pipeline since this CimInstance is returned by SetCimInstance.", 4);
}
}
else
{
DebugHelper.WriteLog("Assert. CimSetCimInstance::SetCimInstance has NULL CimSetCimInstanceContext", 4);
}
}
base.WriteObject(sendToPipeline, context);
}
public override void WriteObject(object sendToPipeline, bool enumerateCollection, XOperationContextBase context)
{
if (sendToPipeline is CimInstance)
{
this.WriteObject(sendToPipeline, context);
}
else
{
base.WriteObject(sendToPipeline, enumerateCollection, context);
}
}
#region private methods
private readonly CimSetCimInstance setCimInstance;
private const string theCimSetCimInstanceParameterName = @"theCimSetCimInstance";
#endregion
}
#endregion
#region Class CmdletOperationInvokeCimMethod
/// <summary>
/// <para>
/// Wrapper of Cmdlet, override WriteObject function call since
/// we need to invoke cim method.
/// </para>
/// </summary>
internal class CmdletOperationInvokeCimMethod : CmdletOperationBase
{
/// <summary>
/// Initializes a new instance of the <see cref="CmdletOperationInvokeCimMethod"/> class.
/// </summary>
/// <param name="cmdlet"></param>
public CmdletOperationInvokeCimMethod(Cmdlet cmdlet,
CimInvokeCimMethod theCimInvokeCimMethod)
: base(cmdlet)
{
ValidationHelper.ValidateNoNullArgument(theCimInvokeCimMethod, theCimInvokeCimMethodParameterName);
this.cimInvokeCimMethod = theCimInvokeCimMethod;
}
/// <summary>
/// <para>
/// Object here need to be removed if it is CimInstance
/// </para>
/// </summary>
/// <param name="sendToPipeline"></param>
public override void WriteObject(object sendToPipeline, XOperationContextBase context)
{
DebugHelper.WriteLogEx();
if (sendToPipeline is CimInstance)
{
this.cimInvokeCimMethod.InvokeCimMethodOnCimInstance(sendToPipeline as CimInstance, context, this);
}
else
{
base.WriteObject(sendToPipeline, context);
}
}
public override void WriteObject(object sendToPipeline, bool enumerateCollection, XOperationContextBase context)
{
if (sendToPipeline is CimInstance)
{
this.WriteObject(sendToPipeline, context);
}
else
{
base.WriteObject(sendToPipeline, enumerateCollection, context);
}
}
#region private methods
private readonly CimInvokeCimMethod cimInvokeCimMethod;
private const string theCimInvokeCimMethodParameterName = @"theCimInvokeCimMethod";
#endregion
}
#endregion
#region Class CmdletOperationTestCimSession
/// <summary>
/// <para>
/// Wrapper of Cmdlet, override WriteObject function call since
/// we need to add cim session to global cache.
/// </para>
/// </summary>
internal class CmdletOperationTestCimSession : CmdletOperationBase
{
/// <summary>
/// Initializes a new instance of the <see cref="CmdletOperationTestCimSession"/> class.
/// </summary>
/// <param name="cmdlet"></param>
public CmdletOperationTestCimSession(Cmdlet cmdlet,
CimNewSession theCimNewSession)
: base(cmdlet)
{
ValidationHelper.ValidateNoNullArgument(theCimNewSession, theCimNewSessionParameterName);
this.cimNewSession = theCimNewSession;
}
/// <summary>
/// <para>
/// Add session object to cache
/// </para>
/// </summary>
/// <param name="sendToPipeline"></param>
public override void WriteObject(object sendToPipeline, XOperationContextBase context)
{
DebugHelper.WriteLogEx();
if (sendToPipeline is CimSession)
{
DebugHelper.WriteLog("Call CimNewSession::AddSessionToCache", 1);
this.cimNewSession.AddSessionToCache(sendToPipeline as CimSession, context, this);
}
else if (sendToPipeline is PSObject)
{
DebugHelper.WriteLog("Write PSObject to pipeline", 1);
base.WriteObject(sendToPipeline, context);
}
else
{
// NOTES: May need to output for warning message/verbose message
DebugHelper.WriteLog("Ignore other type object {0}", 1, sendToPipeline);
}
}
#region private methods
private readonly CimNewSession cimNewSession;
private const string theCimNewSessionParameterName = @"theCimNewSession";
#endregion
}
#endregion
}
|