Merge pull request #478 from awsdocs/csharp-handler-example

Add C# receipt handler example in example-csharp

Author: yualexan

sample-apps/example-csharp/ExampleCS/src/ExampleCS/ExampleCS.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
+    <AWSProjectType>Lambda</AWSProjectType>
+    <!-- This property makes the build directory similar to a publish directory and helps the AWS .NET Lambda Mock Test Tool find project dependencies. -->
+    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
+    <!-- Generate ready to run images during publishing to improve cold start time. -->
+    <PublishReadyToRun>true</PublishReadyToRun>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="Amazon.Lambda.Core" Version="2.5.0" />
+    <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.4" />
+    <PackageReference Include="AWSSDK.S3" Version="3.7.415.5" />
+  </ItemGroup>
+</Project>

sample-apps/example-csharp/ExampleCS/src/ExampleCS/Function.cs

@@ -0,0 +1,68 @@
+using System;
+using System.Text;
+using System.Threading.Tasks;
+using Amazon.Lambda.Core;
+using Amazon.S3;
+using Amazon.S3.Model;
+
+// Assembly attribute to enable Lambda function logging
+[assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer))]
+
+namespace ExampleLambda;
+
+public class Order
+{
+    public string OrderId { get; set; } = string.Empty;
+    public double Amount { get; set; }
+    public string Item { get; set; } = string.Empty;
+}
+
+public class OrderHandler
+{
+    private static readonly AmazonS3Client s3Client = new();
+
+    public async Task<string> HandleRequest(Order order, ILambdaContext context)
+    {
+        try
+        {
+            string? bucketName = Environment.GetEnvironmentVariable("RECEIPT_BUCKET");
+            if (string.IsNullOrWhiteSpace(bucketName))
+            {
+                throw new ArgumentException("RECEIPT_BUCKET environment variable is not set");
+            }
+
+            string receiptContent = $"OrderID: {order.OrderId}\nAmount: ${order.Amount:F2}\nItem: {order.Item}";
+            string key = $"receipts/{order.OrderId}.txt";
+
+            await UploadReceiptToS3(bucketName, key, receiptContent);
+
+            context.Logger.LogInformation($"Successfully processed order {order.OrderId} and stored receipt in S3 bucket {bucketName}");
+            return "Success";
+        }
+        catch (Exception ex)
+        {
+            context.Logger.LogError($"Failed to process order: {ex.Message}");
+            throw;
+        }
+    }
+
+    private async Task UploadReceiptToS3(string bucketName, string key, string receiptContent)
+    {
+        try
+        {
+            var putRequest = new PutObjectRequest
+            {
+                BucketName = bucketName,
+                Key = key,
+                ContentBody = receiptContent,
+                ContentType = "text/plain"
+            };
+
+            await s3Client.PutObjectAsync(putRequest);
+        }
+        catch (AmazonS3Exception ex)
+        {
+            throw new Exception($"Failed to upload receipt to S3: {ex.Message}", ex);
+        }
+    }
+}

sample-apps/example-csharp/ExampleCS/src/ExampleCS/Readme.md

@@ -0,0 +1,49 @@
+# AWS Lambda Empty Function Project
+
+This starter project consists of:
+* Function.cs - class file containing a class with a single function handler method
+* aws-lambda-tools-defaults.json - default argument settings for use with Visual Studio and command line deployment tools for AWS
+
+You may also have a test project depending on the options selected.
+
+The generated function handler is a simple method accepting a string argument that returns the uppercase equivalent of the input string. Replace the body of this method, and parameters, to suit your needs. 
+
+## Here are some steps to follow from Visual Studio:
+
+To deploy your function to AWS Lambda, right click the project in Solution Explorer and select *Publish to AWS Lambda*.
+
+To view your deployed function open its Function View window by double-clicking the function name shown beneath the AWS Lambda node in the AWS Explorer tree.
+
+To perform testing against your deployed function use the Test Invoke tab in the opened Function View window.
+
+To configure event sources for your deployed function, for example to have your function invoked when an object is created in an Amazon S3 bucket, use the Event Sources tab in the opened Function View window.
+
+To update the runtime configuration of your deployed function use the Configuration tab in the opened Function View window.
+
+To view execution logs of invocations of your function use the Logs tab in the opened Function View window.
+
+## Here are some steps to follow to get started from the command line:
+
+Once you have edited your template and code you can deploy your application using the [Amazon.Lambda.Tools Global Tool](https://github.com/aws/aws-extensions-for-dotnet-cli#aws-lambda-amazonlambdatools) from the command line.
+
+Install Amazon.Lambda.Tools Global Tools if not already installed.
+```
+    dotnet tool install -g Amazon.Lambda.Tools
+```
+
+If already installed check if new version is available.
+```
+    dotnet tool update -g Amazon.Lambda.Tools
+```
+
+Execute unit tests
+```
+    cd "ExampleCS/test/ExampleCS.Tests"
+    dotnet test
+```
+
+Deploy function to AWS Lambda
+```
+    cd "ExampleCS/src/ExampleCS"
+    dotnet lambda deploy-function
+```

sample-apps/example-csharp/ExampleCS/src/ExampleCS/aws-lambda-tools-defaults.json

@@ -0,0 +1,16 @@
+{
+  "Information": [
+    "This file provides default values for the deployment wizard inside Visual Studio and the AWS Lambda commands added to the .NET Core CLI.",
+    "To learn more about the Lambda commands with the .NET Core CLI execute the following command at the command line in the project root directory.",
+    "dotnet lambda help",
+    "All the command line options for the Lambda command can be specified in this file."
+  ],
+  "profile": "default",
+  "region": "us-east-1",
+  "configuration": "Release",
+  "function-architecture": "x86_64",
+  "function-runtime": "dotnet8",
+  "function-memory-size": 512,
+  "function-timeout": 30,
+  "function-handler": "ExampleCS::ExampleLambda.OrderHandler::HandleRequest"
+}

sample-apps/example-csharp/ExampleCS/test/ExampleCS.Tests/ExampleCS.Tests.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <IsTestProject>true</IsTestProject>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="Amazon.Lambda.Core" Version="2.5.0" />
+    <PackageReference Include="Amazon.Lambda.TestUtilities" Version="2.0.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageReference Include="xunit" Version="2.9.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2" />
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\ExampleCS\ExampleCS.csproj" />
+  </ItemGroup>
+</Project>

sample-apps/example-csharp/ExampleCS/test/ExampleCS.Tests/FunctionTest.cs

@@ -0,0 +1,20 @@
+using Xunit;
+using Amazon.Lambda.Core;
+using Amazon.Lambda.TestUtilities;
+
+namespace ExampleCS.Tests;
+
+public class FunctionTest
+{
+    [Fact]
+    public void TestToUpperFunction()
+    {
+
+        // Invoke the lambda function and confirm the string was upper cased.
+        var function = new Function();
+        var context = new TestLambdaContext();
+        var upperCase = function.FunctionHandler("hello world", context);
+
+        Assert.Equal("HELLO WORLD", upperCase);
+    }
+}