/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file 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. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.CloudFront; using Amazon.CloudFront.Model; namespace Amazon.PowerShell.Cmdlets.CF { /// /// Tests a CloudFront function. /// /// /// /// To test a function, you provide an event object that represents an HTTP request /// or response that your CloudFront distribution could receive in production. CloudFront /// runs the function, passing it the event object that you provided, and returns the /// function's result (the modified event object) in the response. The response also contains /// function logs and error messages, if any exist. For more information about testing /// functions, see Testing /// functions in the Amazon CloudFront Developer Guide. /// /// To test a function, you provide the function's name and version (ETag /// value) along with the event object. To get the function's name and version, you can /// use ListFunctions and DescribeFunction. /// /// [Cmdlet("Test", "CFFunction")] [OutputType("Amazon.CloudFront.Model.TestResult")] [AWSCmdlet("Calls the Amazon CloudFront TestFunction API operation.", Operation = new[] {"TestFunction"}, SelectReturnType = typeof(Amazon.CloudFront.Model.TestFunctionResponse))] [AWSCmdletOutput("Amazon.CloudFront.Model.TestResult or Amazon.CloudFront.Model.TestFunctionResponse", "This cmdlet returns an Amazon.CloudFront.Model.TestResult object.", "The service call response (type Amazon.CloudFront.Model.TestFunctionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class TestCFFunctionCmdlet : AmazonCloudFrontClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter EventObject /// /// /// The event object to test the function with. For more information about the structure /// of the event object, see Testing /// functions in the Amazon CloudFront Developer Guide. /// /// The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service. /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Amazon.PowerShell.Common.MemoryStreamParameterConverter] public byte[] EventObject { get; set; } #endregion #region Parameter IfMatch /// /// /// The current version (ETag value) of the function that you are testing, /// which you can get using DescribeFunction. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String IfMatch { get; set; } #endregion #region Parameter Name /// /// /// The name of the function that you are testing. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String Name { get; set; } #endregion #region Parameter Stage /// /// /// The stage of the function that you are testing, either DEVELOPMENT or /// LIVE. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.CloudFront.FunctionStage")] public Amazon.CloudFront.FunctionStage Stage { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'TestResult'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudFront.Model.TestFunctionResponse). /// Specifying the name of a property of type Amazon.CloudFront.Model.TestFunctionResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "TestResult"; #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.EventObject = this.EventObject; #if MODULAR if (this.EventObject == null && ParameterWasBound(nameof(this.EventObject))) { WriteWarning("You are passing $null as a value for parameter EventObject which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.IfMatch = this.IfMatch; #if MODULAR if (this.IfMatch == null && ParameterWasBound(nameof(this.IfMatch))) { WriteWarning("You are passing $null as a value for parameter IfMatch which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.Name = this.Name; #if MODULAR if (this.Name == null && ParameterWasBound(nameof(this.Name))) { WriteWarning("You are passing $null as a value for parameter Name which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.Stage = this.Stage; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { System.IO.MemoryStream _EventObjectStream = null; try { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.CloudFront.Model.TestFunctionRequest(); if (cmdletContext.EventObject != null) { _EventObjectStream = new System.IO.MemoryStream(cmdletContext.EventObject); request.EventObject = _EventObjectStream; } if (cmdletContext.IfMatch != null) { request.IfMatch = cmdletContext.IfMatch; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.Stage != null) { request.Stage = cmdletContext.Stage; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } finally { if( _EventObjectStream != null) { _EventObjectStream.Dispose(); } } } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.CloudFront.Model.TestFunctionResponse CallAWSServiceOperation(IAmazonCloudFront client, Amazon.CloudFront.Model.TestFunctionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon CloudFront", "TestFunction"); try { #if DESKTOP return client.TestFunction(request); #elif CORECLR return client.TestFunctionAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public byte[] EventObject { get; set; } public System.String IfMatch { get; set; } public System.String Name { get; set; } public Amazon.CloudFront.FunctionStage Stage { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.TestResult; } } }