Skip to content

refactor: provider-cloudformation and amplify-category-storage #14238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 14 commits into
base: dev
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/amplify-category-storage/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,11 @@
"@aws-amplify/amplify-prompts": "2.8.7",
"@aws-amplify/amplify-util-import": "2.8.3",
"@aws-amplify/cli-extensibility-helper": "3.0.39",
"@aws-sdk/client-dynamodb": "^3.515.0",
"@aws-sdk/client-s3": "^3.515.0",
"amplify-headless-interface": "1.17.8",
"amplify-util-headless-input": "1.9.19",
"aws-cdk-lib": "~2.189.1",
"aws-sdk": "^2.1464.0",
"chalk": "^4.1.1",
"constructs": "^10.0.5",
"enquirer": "^2.3.6",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
} from '@aws-amplify/amplify-cli-core';
import { printer } from '@aws-amplify/amplify-prompts';
import { IS3Service } from '@aws-amplify/amplify-util-import';
import { Bucket } from 'aws-sdk/clients/s3';
import { Bucket } from '@aws-sdk/client-s3';
import Enquirer from 'enquirer';
import _ from 'lodash';
import { v4 as uuid } from 'uuid';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { $TSContext, $TSObject } from '@aws-amplify/amplify-cli-core';
import { IDynamoDBService, IS3Service } from '@aws-amplify/amplify-util-import';
import { Bucket } from 'aws-sdk/clients/s3';
import { TableDescription } from 'aws-sdk/clients/dynamodb';
import { Bucket } from '@aws-sdk/client-s3';
import { TableDescription } from '@aws-sdk/client-dynamodb';

// parameters.json
export type S3ResourceParameters = {
Expand Down
5 changes: 4 additions & 1 deletion packages/amplify-provider-awscloudformation/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@
import { $TSAny } from '@aws-amplify/amplify-cli-core';
import { $TSContext } from '@aws-amplify/amplify-cli-core';
import { $TSObject } from '@aws-amplify/amplify-cli-core';
import * as AWS_2 from 'aws-sdk';
import { CognitoIdentityProviderClient } from '@aws-sdk/client-cognito-identity-provider';
import { IAmplifyResource } from '@aws-amplify/amplify-cli-core';
import { LocationClient } from '@aws-sdk/client-location';
import { NodeHttpHandler } from '@smithy/node-http-handler';
import { SSMClient } from '@aws-sdk/client-ssm';
import { Template } from '@aws-amplify/amplify-cli-core';

// @public (undocumented)
Expand All @@ -26,6 +27,8 @@ export interface AwsSdkConfig {
// (undocumented)
region: string;
// (undocumented)
requestHandler?: NodeHttpHandler;
// (undocumented)
secretAccessKey: string;
// (undocumented)
sessionToken?: string;
Expand Down
26 changes: 25 additions & 1 deletion packages/amplify-provider-awscloudformation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,34 @@
"@aws-amplify/cli-extensibility-helper": "3.0.39",
"@aws-amplify/graphql-transformer-core": "^2.11.1",
"@aws-amplify/graphql-transformer-interfaces": "^3.12.0",
"@aws-sdk/client-amplify": "^3.624.0",
"@aws-sdk/client-api-gateway": "^3.624.0",
"@aws-sdk/client-appsync": "^3.624.0",
"@aws-sdk/client-cloudformation": "^3.624.0",
"@aws-sdk/client-cognito-identity": "^3.624.0",
"@aws-sdk/client-cognito-identity-provider": "^3.624.0",
"@aws-sdk/client-dynamodb": "^3.624.0",
"@aws-sdk/client-ec2": "^3.624.0",
"@aws-sdk/client-ecr": "^3.624.0",
"@aws-sdk/client-iam": "^3.624.0",
"@aws-sdk/client-lambda": "^3.624.0",
"@aws-sdk/client-lex-model-building-service": "^3.624.0",
"@aws-sdk/client-location": "^3.624.0",
"@aws-sdk/client-polly": "^3.624.0",
"@aws-sdk/client-route-53": "^3.624.0",
"@aws-sdk/client-s3": "^3.624.0",
"@aws-sdk/client-sagemaker": "^3.624.0",
"@aws-sdk/client-secrets-manager": "^3.624.0",
"@aws-sdk/client-sns": "^3.624.0",
"@aws-sdk/client-ssm": "^3.624.0",
"@aws-sdk/client-sts": "^3.624.0",
"@aws-sdk/credential-provider-node": "^3.624.0",
"@aws-sdk/credential-providers": "^3.624.0",
"@aws-sdk/lib-dynamodb": "^3.624.0",
"@aws-sdk/lib-storage": "^3.624.0",
"@aws-sdk/s3-request-presigner": "^3.624.0",
"@aws-sdk/types": "^3.624.0",
"@smithy/node-http-handler": "^4.0.6",
"@smithy/node-http-handler": "^4.1.0",
"amplify-codegen": "^4.10.3",
"archiver": "^7.0.1",
"aws-cdk-lib": "~2.189.1",
Expand Down Expand Up @@ -82,6 +104,8 @@
"@types/lodash.throttle": "^4.1.6",
"@types/node": "^18.16.0",
"@types/uuid": "^8.0.0",
"aws-sdk-client-mock": "^4.1.0",
"aws-sdk-client-mock-jest": "^4.1.0",
"jest": "^29.7.0",
"typescript": "^4.9.5"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
import { Amplify } from 'aws-sdk';
import { stateManager } from '@aws-amplify/amplify-cli-core';
import { getConfiguredAmplifyClient } from '../aws-utils/aws-amplify';
import { checkAmplifyServiceIAMPermission } from '../amplify-service-permission-check';
import { init } from '../amplify-service-manager';
import { mockClient } from 'aws-sdk-client-mock';
import 'aws-sdk-client-mock-jest';
import { AmplifyClient, CreateAppCommand } from '@aws-sdk/client-amplify';

jest.mock('../aws-utils/aws-amplify');
jest.mock('../amplify-service-permission-check');

const amplifyClientStub = {
createApp: jest.fn().mockReturnValue({
promise: jest.fn().mockRejectedValue({
code: 'LimitExceededException',
}),
}),
} as unknown as Amplify;
const mockAmplifyClient = mockClient(AmplifyClient);
const getConfiguredAmplifyClientMock = getConfiguredAmplifyClient as jest.MockedFunction<typeof getConfiguredAmplifyClient>;
getConfiguredAmplifyClientMock.mockResolvedValue(amplifyClientStub);

const checkAmplifyServiceIAMPermissionMock = checkAmplifyServiceIAMPermission as jest.MockedFunction<
typeof checkAmplifyServiceIAMPermission
Expand All @@ -25,7 +20,16 @@ checkAmplifyServiceIAMPermissionMock.mockResolvedValue(true);
jest.spyOn(stateManager, 'teamProviderInfoExists').mockReturnValue(false);

describe('init', () => {
beforeEach(() => {
getConfiguredAmplifyClientMock.mockClear();
mockAmplifyClient.reset();
});
it('throws ProjectInitError if Amplify app limit has been reached', async () => {
mockAmplifyClient.on(CreateAppCommand).rejectsOnce({
name: 'LimitExceededException',
});
getConfiguredAmplifyClientMock.mockResolvedValue(mockAmplifyClient as unknown as AmplifyClient);

const amplifyServiceParamsStub = {
context: {},
awsConfigInfo: {},
Expand All @@ -39,16 +43,11 @@ describe('init', () => {
});

it('throws Configutation error if config level is general and soorcing wrong credentials', async () => {
const amplifyClientGeneralConfigStub = {
createApp: jest.fn().mockReturnValue({
promise: jest.fn().mockRejectedValue({
code: 'ConfigError',
message: 'Missing Region in Config',
}),
}),
} as unknown as Amplify;
getConfiguredAmplifyClientMock.mockClear();
getConfiguredAmplifyClientMock.mockResolvedValue(amplifyClientGeneralConfigStub);
mockAmplifyClient.on(CreateAppCommand).rejectsOnce({
name: 'ConfigError',
message: 'Missing Region in Config',
});
getConfiguredAmplifyClientMock.mockResolvedValue(mockAmplifyClient as unknown as AmplifyClient);

const amplifyServiceParamsStub = {
context: {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,44 +1,57 @@
import { $TSContext } from '@aws-amplify/amplify-cli-core';
import { createS3Service } from '../../aws-utils/S3Service';
import { HeadBucketCommand } from '@aws-sdk/client-s3';

jest.mock('aws-sdk', () => {
const mockHeadBucketForUsEast1 = jest.fn().mockImplementation((params: { Bucket: string }) => {
return {
promise: jest.fn().mockImplementation(() => {
if (params.Bucket.includes('us-east-1')) {
return Promise.resolve({});
}
return Promise.reject({ code: 'BadRequest', region: 'eu-south-1' });
}),
};
// Mock the AWS SDK v3 S3Client
jest.mock('@aws-sdk/client-s3', () => {
const mockSendForUsEast1 = jest.fn().mockImplementation(async (command) => {
if (command instanceof HeadBucketCommand) {
const params = command.input;
if (params.Bucket!.includes('us-east-1')) {
return {};
}
const error = new Error('BadRequest');
error.name = 'BadRequest';
throw error;
}
return {};
});

const mockSendForEuSouth1 = jest.fn().mockImplementation(async (command) => {
if (command instanceof HeadBucketCommand) {
const params = command.input;
if (params.Bucket!.includes('eu-south-1')) {
return {};
}
const error = new Error('BadRequest');
error.name = 'BadRequest';
throw error;
}
return {};
});

const mockHeadBucketForEuSouth1 = jest.fn().mockImplementation((params) => {
// Mock S3Client constructor
const mockS3Client = jest.fn().mockImplementation((options) => {
const region = options.region || 'us-east-1';

return {
promise: jest.fn().mockImplementation(() => {
if (params.Bucket.includes('eu-south-1')) {
return Promise.resolve({});
}
return Promise.reject({ code: 'BadRequest', region: 'us-east-1' });
}),
send: region === 'eu-south-1' ? mockSendForEuSouth1 : mockSendForUsEast1,
config: {
region,
credentials: options.credentials,
},
};
});

return {
S3: jest.fn((options) => {
const region = options.region || 'us-east-1';
if (region === 'eu-south-1') {
return {
headBucket: mockHeadBucketForEuSouth1,
};
}
S3Client: mockS3Client,
HeadBucketCommand: jest.fn().mockImplementation((params) => {
return {
config: {
region,
},
headBucket: mockHeadBucketForUsEast1,
input: params,
};
}),
ListBucketsCommand: jest.fn(),
GetBucketLocationCommand: jest.fn(),
};
});

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { ResourceStatus } from '@aws-sdk/client-cloudformation';
import {
deserializeErrorMessages,
CFNErrorMessages,
Expand All @@ -11,7 +12,7 @@ const eventsWithFailure = [
PhysicalResourceId: 'testStackId1',
LogicalResourceId: 'testLogicalResourceId1',
ResourceType: 'AWS::IAM::Role',
ResourceStatus: 'CREATE_FAILED',
ResourceStatus: ResourceStatus.CREATE_FAILED,
ResourceStatusReason: 'Some valid reason 1',
// below properties are useless since we don't use them in the code
StackId: 'testStackId1',
Expand All @@ -23,7 +24,7 @@ const eventsWithFailure = [
PhysicalResourceId: 'testStackId2',
LogicalResourceId: 'testLogicalResourceId2',
ResourceType: 'AWS::CloudFormation::Stack',
ResourceStatus: 'UPDATE_FAILED',
ResourceStatus: ResourceStatus.UPDATE_FAILED,
ResourceStatusReason: 'Some valid reason 2',
// below properties are useless since we don't use them in the code
StackId: 'testStackId2',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ import {
import { pathManager, stateManager, readCFNTemplate, writeCFNTemplate, CFNTemplateFormat } from '@aws-amplify/amplify-cli-core';
import * as fs from 'fs-extra';
import { S3 } from '../../aws-utils/aws-s3';
import { CloudFormation } from 'aws-sdk';
import { getPreviousDeploymentRecord } from '../../utils/amplify-resource-state-utils';
import Template from 'cloudform-types/types/template';
import { DeploymentOp, DeploymentStep } from '../../iterative-deployment';
import { CloudFormationClient } from '@aws-sdk/client-cloudformation';

jest.mock('fs-extra');
jest.mock('@aws-amplify/amplify-cli-core');
Expand Down Expand Up @@ -147,14 +147,12 @@ describe('uploadTempFuncDeploymentFiles', () => {
describe('generateIterativeFuncDeploymentSteps', () => {
it('generates steps with correct pointers', async () => {
const cfnClient_stub = {
describeStackResources: () => ({
promise: async () => ({
StackResources: [
{
PhysicalResourceId: 'testStackId',
},
],
}),
send: () => ({
StackResources: [
{
PhysicalResourceId: 'testStackId',
},
],
}),
};
getPreviousDeploymentRecord_mock
Expand All @@ -173,7 +171,7 @@ describe('generateIterativeFuncDeploymentSteps', () => {
stateManager_mock.getResourceParametersJson.mockReturnValue({});
stateManager_mock.getTeamProviderInfo.mockReturnValue({});
stateManager_mock.getLocalEnvInfo.mockReturnValue({ envName: 'testenv' });
const result = await generateIterativeFuncDeploymentSteps(cfnClient_stub as unknown as CloudFormation, 'testRootStackId', [
const result = await generateIterativeFuncDeploymentSteps(cfnClient_stub as unknown as CloudFormationClient, 'testRootStackId', [
'func1',
'func2',
]);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { ApiCategoryFacade, BannerMessage, stateManager } from '@aws-amplify/amplify-cli-core';
import { AWSError } from 'aws-sdk';
import { printer } from '@aws-amplify/amplify-prompts';
import { SNS } from '../aws-utils/aws-sns';
import { showGraphQLTransformerVersion, showSMSSandboxWarning } from '../display-helpful-urls';
import { AwsError } from 'aws-sdk-client-mock';

jest.mock('../aws-utils/aws-sns');
jest.mock('@aws-amplify/amplify-cli-core');
Expand Down Expand Up @@ -77,8 +77,8 @@ describe('showSMSSandBoxWarning', () => {

describe('when IAM user is missing sandbox permission', () => {
beforeEach(() => {
const authError = new Error() as AWSError;
authError.code = 'AuthorizationError';
const authError = new Error() as AwsError;
authError.name = 'AuthorizationError';
mockedSNSClientInstance.isInSandboxMode.mockRejectedValue(authError);
});
it('should not show any warning if there is no message associated', async () => {
Expand Down Expand Up @@ -110,8 +110,8 @@ describe('showSMSSandBoxWarning', () => {

describe('it should not show any warning message when the SNS API is not deployed', () => {
beforeEach(() => {
const resourceNotFoundError = new Error() as AWSError;
resourceNotFoundError.code = 'ResourceNotFound';
const resourceNotFoundError = new Error() as AwsError;
resourceNotFoundError.name = 'ResourceNotFound';
mockedSNSClientInstance.isInSandboxMode.mockRejectedValue(resourceNotFoundError);
});
it('should not print error', async () => {
Expand All @@ -127,8 +127,8 @@ describe('showSMSSandBoxWarning', () => {

describe('it should not show any warning message when there is a network error', () => {
beforeEach(() => {
const networkError = new Error() as AWSError;
networkError.code = 'UnknownEndpoint';
const networkError = new Error() as AwsError;
networkError.name = 'UnknownEndpoint';
mockedSNSClientInstance.isInSandboxMode.mockRejectedValue(networkError);
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ describe('initialize environment', () => {
},
} as unknown as $TSContext;
it('throws AmplifyError if the deployment bucket does not exist', async () => {
downloadZipMock.mockRejectedValueOnce({ code: 'NoSuchBucket' });
downloadZipMock.mockRejectedValueOnce({ name: 'NoSuchBucket' });
const actual = await expect(run(contextStub, {})).rejects;
await actual.toBeInstanceOf(AmplifyException);
await actual.toMatchInlineSnapshot(
Expand Down
Loading
Loading