Merge pull request #506 from ericksoen/update-aws-lambda-tools-docs

Update aws lambda tools docs

Author: normj

Tools/LambdaTestTool/Amazon.Lambda.TestTool.Tests/LoadLambdaFunctionTests.cs

@@ -9,7 +9,7 @@ namespace Amazon.Lambda.TestTool.Tests
     public class LoadLambdaFunctionTests
     {
         [Fact]
-        public void LoadInstaneMethodWithAssemblySerializer()
+        public void LoadInstanceMethodWithAssemblySerializer()
         {
             var configFile = Path.GetFullPath(@"../../../../LambdaFunctions/S3EventFunction/aws-lambda-tools-defaults.json");
             var buildPath = Path.GetFullPath(@"../../../../LambdaFunctions/S3EventFunction/bin/debug/netcoreapp2.1");

Tools/LambdaTestTool/Amazon.Lambda.TestTool/Runtime/LocalLambdaRuntime.cs

@@ -18,7 +18,7 @@ public interface ILocalLambdaRuntime : IDisposable
         IList<LambdaFunction> LoadLambdaFunctions(IList<LambdaFunctionInfo> configInfos);
         ExecutionResponse ExecuteLambdaFunction(ExecutionRequest request);
     }
-    
+
     /// <summary>
     /// A mock Lambda runtime to execute Lambda functions.
     /// </summary>
@@ -44,18 +44,18 @@ public static ILocalLambdaRuntime Initialize(string directory)
             var depsFile = Directory.GetFiles(directory, "*.deps.json").FirstOrDefault();
             if (depsFile == null)
             {
-                throw new Exception("Failed to find a deps.json file");
+                throw new Exception($"Failed to find a deps.json file in the specified directory ({directory})");
             }
 
             var fileName = depsFile.Substring(0, depsFile.Length - ".deps.json".Length) + ".dll";
             if (!File.Exists(fileName))
             {
-                throw new Exception("Failed to find Lambda project entry assembly");
+                throw new Exception($"Failed to find Lambda project entry assembly in the specified directory ({directory})");
             }
-            
+
             // The resolver provides the ability to load the assemblies containing the select Lambda function.
             var resolver = new LambdaAssemblyResolver(fileName);
-            
+
             var runtime = new LocalLambdaRuntime(resolver, directory);
             return runtime;
         }
@@ -68,7 +68,7 @@ public IList<LambdaFunction> LoadLambdaFunctions(IList<LambdaFunctionInfo> confi
             {
                 functions.Add(LoadLambdaFunction(configInfo));
             }
-            
+
             return functions;
         }
 
@@ -88,7 +88,7 @@ public LambdaFunction LoadLambdaFunction(LambdaFunctionInfo functionInfo)
                 function.ErrorMessage = $"Invalid format for function handler string {functionInfo.Handler}. Format is <assembly>::<type-name>::<method>.";
                 return function;
             }
-            
+
             // Using our custom Assembly resolver load the target Assembly.
             function.LambdaAssembly = this.Resolver.LoadAssembly(handlerTokens[0]);
             if (function.LambdaAssembly == null)
@@ -114,7 +114,7 @@ public LambdaFunction LoadLambdaFunction(LambdaFunctionInfo functionInfo)
             else
             {
                 // TODO: Handle method overloads
-                if(methodInfos.Length > 1)
+                if (methodInfos.Length > 1)
                 {
                     function.ErrorMessage = $"More then one method called {handlerTokens[2]} was found. This tool does not currently support method overloading.";
                 }
@@ -128,8 +128,8 @@ public LambdaFunction LoadLambdaFunction(LambdaFunctionInfo functionInfo)
             // Search to see if a Lambda serializer is registered.
             var attribute = function.LambdaMethod.GetCustomAttribute(typeof(LambdaSerializerAttribute)) as LambdaSerializerAttribute ??
                             function.LambdaAssembly.GetCustomAttribute(typeof(LambdaSerializerAttribute)) as LambdaSerializerAttribute;
-            
-            
+
+
             if (attribute != null)
             {
                 function.Serializer = Activator.CreateInstance(attribute.SerializerType) as ILambdaSerializer;
@@ -138,7 +138,7 @@ public LambdaFunction LoadLambdaFunction(LambdaFunctionInfo functionInfo)
 
             return function;
         }
-               
+
         /// <summary>
         /// Execute the Lambda function.
         /// </summary>

Tools/LambdaTestTool/README.md

@@ -2,17 +2,20 @@
 
 The AWS .NET Mock Lambda Test Tool is a tool that can be used to load a .NET Core Lambda project and execute the selected code inside an emulated Lambda environment. An IDE that is attached to the process hosting this tool can then debug and step through the .NET Core Lambda code. The tool is optimized for quick local debugging with minimal dependencies.
 
-**Note:** this tool is not a local Lambda environment. This tool is optimized for quick local debugging with minimal dependencies. For example, the targeted .NET Core Lambda code is run within the process of this tool which is run on the host OS. The host OS is usually Windows or macOS.  The host OS is not Amazon Linux, the OS for the Lambda service. Due to these design differences, this tool is not intended to diagnose platform specific issues but instead it can be useful for debugging application logic issues.
+![](./Resources/TestHarness.png)
 
-* [Getting Started](#getting-help)
-* [Installing and Running](#installing-and-running)
-* [Configure for Visual Studio](#configure-for-visual-studio)
-* [Configure for Visual Studio Code](#configure-for-visual-studio-code)
-* [Configure for JetBrains Rider](#configure-for-jetbrains-rider)
-* [Configure for Visual Studio for Mac](#configure-for-visual-studio-for-mac)
-* [Known Limitations](#known-limitations)
+**Note:** this tool is not a local Lambda environment. This tool is optimized for quick local debugging with minimal dependencies. For example, the targeted .NET Core Lambda code is run within the process of this tool which is run on the host OS. The host OS is usually Windows or macOS. The host OS is not Amazon Linux, the OS for the Lambda service. Due to these design differences, this tool is not intended to diagnose platform specific issues but instead it can be useful for debugging application logic issues.
+
+- [Getting Started](#getting-help)
+- [Installing and Running](#installing-and-running)
+- [Configure for Visual Studio](#configure-for-visual-studio)
+- [Configure for Visual Studio Code](#configure-for-visual-studio-code)
+- [Configure for JetBrains Rider](#configure-for-jetbrains-rider)
+- [Configure for Visual Studio for Mac](#configure-for-visual-studio-for-mac)
+- [Known Limitations](#known-limitations)
 
 ## Getting Help
+
 This tool is currently in preview and there are some known limitations. For questions and problems please open a GitHub issue in this repository.
 
 ## AWS Credentials
@@ -88,7 +91,15 @@ To debug with Visual Studio Code and the .NET Mock Lambda Test Tool edit the [la
             "stopAtEntry": false,
             "internalConsoleOptions": "openOnSessionStart"
         },
-```        
+```
+
+To customize the launch behavior for the debugger, you can pass additional arguments via the `args` property:
+
+| Name             | Default Value             | Example                                     |
+| ---------------- | ------------------------- | ------------------------------------------- |
+| port             | 5050                      | `["--port", "5001"`]                        |
+| suppress browser | False                     | `["--no-launch-window", "true"`]            |
+| path             | Current working directory | `["--path", "C:\\different\\launch\\path"]` |
 
 ## Configure for JetBrains Rider