LazyStack

PetStoreTests Project

In this step we will create a PetStoreTest project to perform an integration test against the PetStoreMacDev stack. We will test:

  • Application SignUp - using the LazyStackAuth library.
  • Application SignIn - using the LazyStackAuth library.
  • Calling the stack using the PetStore - defined in the PetStoreClientSDK library.

6.1 Configure a Gmail Account

The automated tests we will create in this step require a Gmail account. AWS Cognito will email authorization codes to that Gmail account during the tests. For instance, the sign-up process will email the new user a authorization code. Our sign-up process test must log into the user's Gmail account, find the email containing the authorization code and then use that code to finalize the sign-up process.

AWS Cognito requires each user to have a unique email address. We don't want to create a new email address each time we run the tests and deleting users from the Cognito User Pool is not convenient or always what we what.

Lucky for us, Gmail has a nifty feature that allows you to use an email address alias. For example, if you email address is myemail@gmaili.com, you can send email to that address with the alias myemail+01@gmail.com. As far as AWS Cognito is concerned, this alias is a unique email address. This means we can use a single Gmail account to create and test multiple AWS Cognito accounts where each of the AWS Cognito accounts is associated with a unique Gmail address alias.

  1. Create a new Gmail account. We suggest you create a Gmail account just for this purpose and not use any existing Gmail account.
  2. Open your Google Account Settings.
  3. Select Security from menu.
  4. Select "Less secure app access" and turn on access.

6.2 Create PetStoreTests Project

  1. Right Click on "Solution PetStore" in the Solution Explorer pane. The Context Menu appears.
  2. Select "Add → New Project" from the context menu. The "Choose a template for your new project" dialog appears.
  3. Select "Web and Console → Tests → MSTes Project".
  4. Click on the Next button. The "Configure your MSTest Project" dialog appears.
  5. Select ".NET 5.0" for the Target Framework and press the Next button. The second "Configure your MSTest Project" page appears.
  6. Edit project name to read "PetStoreTests".
  7. Click the Create button. The test project is added to your solution.

6.2 Configure Microsoft User Secrets

Visual Studio for Mac does not currently support editing User Secrets from the IDE. Since we have the .NET CLI installed we can use that to set up our secrets.

  1. Generate User-Secrets GUID
    1. Open a Terminal.
    2. CD to the solution folder (LazyStackTutorial\PetStoreMac) and install the dotnet GUID tool if it is not already installed:
      dotnet tool install -g dotnet-guid
    3. Use the guid tool to generate a new GUID:
      guid
      A guid is printed to the console. Make a note of this GUID as you will need it in the next step.

6.3 Configure PetStoreTests Project

Visual Studio for Mac does not currently support editing User Secrets from the IDE. Since we have the .NET CLI installed we can use that to set up our secrets.

  1. Copy this content into the PetStoreTests.csproj file, then replace the UserSecretsId value with the guid you generated in the previous step:
    <Project Sdk="Microsoft.NET.Sdk">
        <PropertyGroup>
            <TargetFramework>net5.0</TargetFramework>
            <IsPackable>false</IsPackable>
            <UserSecretsId>4270b588-c2ce-4c08-91bb-58aa1901134c</UserSecretsId>
        </PropertyGroup>
    
        <ItemGroup>
            <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
            <PackageReference Include="MSTest.TestAdapter" Version="2.1.1" />
            <PackageReference Include="MSTest.TestFramework" Version="2.1.1" />
            <PackageReference Include="coverlet.collector" Version="1.3.0" />
            <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="5.0.1" />
            <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="5.0.0" />
            <ProjectReference Include="..\PetStoreRepo\PetStoreRepo.csproj" />
            <ProjectReference Include="..\PetStoreMacClientSDK\PetStoreMacClientSDK.csproj" />
            <EmbeddedResource Include="..\Stacks\Dev\AwsSettings.json" />   
        </ItemGroup>                        
    </Project>

6.4 Set User Secret Values

  1. Open a Terminal Window
  2. CD into the LazyStackTutorial/PetStoreMac folder.
  3. Set Gmail:Email user secret value:
    dotnet user-secrets -p PetStoreTests set "Gmail:Email" "myemail@gmail.com" 
  4. Set Gmail:Password user secret value:
    dotnet user-secrets -p PetStoreTests set "Gmail:Password" "maypassword" 

6.5 Implement Tests

  1. Delete the PetStoreTests UnitTest1.cs file.
  2. Download PetStoreIntegrationTest.cs and then move it into the PetStoreTests project.

6.6 Run Tests

  1. Select View → Test Explorer. The Test Explorer panel appears.
  2. Run Tests. The integration test completes successfully.

6.7 Step Summary

In this step we created a Integration test project and ran our first tests against the published stack.

Reviewing the contents of the PetStoreIntegrationTest.cs class may yield valuable insights into how you should use the libraries in your client apps. Take note of the following implementation elements:

  • AwsSettings.json is an embedded resource that is loaded by ConfigurationBuilder. This embedded resource references \Stacks\Dev\AwsSettings.json. In a client app, you would introduce condition logic in the csproj file to use \Stacks\Prod\AwsSettings.json for release builds or just distribute the AwsSettings.json file separately to developers using the PetStoreClientSDK.
  • AuthMessages.json is a embedded resource that is loaded by ConfigurationBuilder. Extend this file with new message sets by language to localize the messages emitted by the AuthProcess class. This test does not demonstrate the use of AuthProcess messages but later Tutorial steps will.
  • Dependency injection is used in this test to demonstrate the service registration of IAuthProcess and IAuthProvider.
  • LazyStackAuth is an important library in this project.
    • This test only exercises the simple Happy Path SignUp and SignIn process. If you want to see much more extensive integration tests for AuthProcess, view the LazyStack repo on GitHub.
    • The LzHttpClient class implements the logic necessary for your client to make secure calls to the AWS Stack ApiGateways. The LzHttpClient class uses the Aws, LoadApis and MethodMap sections in the appConfig.