amplify-swift/AmplifyPlugins/API/Tests/APIHostApp/AWSAPIPluginGraphQLIAMTests
Michael Law 54dcdfba37
fix(api): Remove AwsCommonRuntimeKit.cleanUp(), add GraphQL IAM integ tests (#2119)
* chore(api): Add GraphQL IAM integ target

* - Updating the Readme for AWSAPIPluginGraphQLIAMTests
- Fixing the target & scheme
- Adding Base Helpers.swift

* Fix tests

* add issue link

Co-authored-by: Manaswi Manthena <manamaha@amazon.com>
2022-08-10 11:39:44 -04:00
..
Base fix(api): Remove AwsCommonRuntimeKit.cleanUp(), add GraphQL IAM integ tests (#2119) 2022-08-10 11:39:44 -04:00
GraphQLWithIAMIntegrationTests.swift fix(api): Remove AwsCommonRuntimeKit.cleanUp(), add GraphQL IAM integ tests (#2119) 2022-08-10 11:39:44 -04:00
README.md fix(api): Remove AwsCommonRuntimeKit.cleanUp(), add GraphQL IAM integ tests (#2119) 2022-08-10 11:39:44 -04:00
Todo.swift fix(api): Remove AwsCommonRuntimeKit.cleanUp(), add GraphQL IAM integ tests (#2119) 2022-08-10 11:39:44 -04:00

README.md

GraphQL with IAM Auth Integration Tests

The following steps demonstrate how to set up an GraphQL endpoint with AppSync. The auth configured will be IAM. This set up is used to run the tests in GraphQLWithIAMIntegrationTests.swift.

Set-up

Latest tested with amplify CLI version 9.2.1 amplify -v

  1. amplify init

  2. amplify add api

? Select from one of the below mentioned services: `GraphQL`
? Here is the GraphQL API that we will create. Select a setting to edit or continue Authorization modes: API key (default, expiration time: 7 days from now)
? Choose the default authorization type for the API `IAM`
? Configure additional auth types? `No`
? Here is the GraphQL API that we will create. Select a setting to edit or continue `Continue`
? Choose a schema template: `Blank Schema`
 Do you want to edit the schema now? (Y/n) · `Y`

Edit the schema to

type Todo @model @auth(rules: [
  { allow: public, provider: iam }, 
  { allow: private, provider: iam }]) {
  id: ID!
  name: String!
  description: String
}

tip: remove input AMPLIFY { globalAuthRule: AuthRule = { allow: public } } # FOR TESTING ONLY! in the schema

  1. amplify add auth
Do you want to use the default authentication and security configuration? 
    Manual configuration
 Select the authentication/authorization services that you want to use: 
    User Sign-Up, Sign-In, connected with AWS IAM controls (Enables ...)
 Please provide a friendly name for your resource that will be used to label this category in the project: 
    <amplifyintegtest>
 Please enter a name for your identity pool. 
    <amplifyintegtestCIDP>
 Allow unauthenticated logins? (Provides scoped down permissions that you can control via AWS IAM) 
    No
 Do you want to enable 3rd party authentication providers in your identity pool? 
    No
 Please provide a name for your user pool: 
    <amplifyintegCUP>
 How do you want users to be able to sign in? 
    Username
 Do you want to add User Pool Groups? 
    No
 Do you want to add an admin queries API? 
    No
? Do you want to restrict access to the admin queries API to a specific Group 
    No
 Multifactor authentication (MFA) user login options: 
    OFF
 Email based user registration/forgot password: 
    Enabled (Requires per-user email entry at registration)
 Please specify an email verification subject: 
    Your verification code
 Please specify an email verification message: 
    Your verification code is {####}
 Do you want to override the default password policy for this User Pool? 
    No
 What attributes are required for signing up? 
    None
 Specify the app's refresh token expiration period (in days): 
    30
 Do you want to specify the user attributes this app can read and write? 
    No
 Do you want to enable any of the following capabilities?
    (press Enter with none selected)
 Do you want to use an OAuth flow? 
    No
? Do you want to configure Lambda Triggers for Cognito? 
    Yes
? Which triggers do you want to enable for Cognito
    Pre Sign-up
    [Choose as many that you would like to manually verify later]
? What functionality do you want to use for Pre Sign-up 
    Create your own module
Succesfully added the Lambda function locally
? Do you want to edit your custom function now? Yes
Please edit the file in your editor: 

For Pre Sign-up lambda

exports.handler = (event) => {
    event.response.autoConfirmUser = true;
};

Continue in the terminal;

? Press enter to continue
Successfully added resource amplifyintegtest locally
  1. amplify push
? Do you want to generate code for your newly created GraphQL API (Y/n) `n`
  1. Copy amplifyconfiguration.json over as GraphQLWithIAMIntegrationTests-amplifyconfiguration.json to ~/.aws-amplify/amplify-ios/testconfiguration/
cp amplifyconfiguration.json ~/.aws-amplify/amplify-ios/testconfiguration/GraphQLWithIAMIntegrationTests-amplifyconfiguration.json

You can now run the tests!