feat: basic e2e integration test flow for migration tool #13946
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
hoangnbn
reviewed
Sep 30, 2024
hoangnbn
reviewed
Sep 30, 2024
hoangnbn
reviewed
Sep 30, 2024
hoangnbn
reviewed
Sep 30, 2024
hoangnbn
reviewed
Sep 30, 2024
hoangnbn
reviewed
Sep 30, 2024
hoangnbn
reviewed
Sep 30, 2024
| void it('performs full migration codegen flow with Auth backend', async () => { | ||
| await setupGen1Project(projRoot, 'CodegenTest'); | ||
| const { gen1UserPoolId, gen1Region } = await assertGen1Setup(projRoot); | ||
| await migrateCodegen(projRoot); |
There was a problem hiding this comment.
pls rename migrateCodegen to generateGen2Code in the next PR.
hoangnbn
approved these changes
Sep 30, 2024
sobolk
reviewed
Sep 30, 2024
| @@ -0,0 +1,23 @@ | |||
| import path from 'node:path'; | |||
There was a problem hiding this comment.
Can we call this file migration_codegen_e2e.test.ts.
We have tests related other "codegen" in the repo.
Comment on lines
29
to
32
| } catch (error) { | ||
| console.error('Error fetching resource details:', error); | ||
| throw error; | ||
| } |
There was a problem hiding this comment.
Please remove all these catch-log-throw blocks, here and below.
As long as something catches this error at the top and prints it somewhere we can infer details from stack trace.
| .runAsync(); | ||
| } | ||
|
|
||
| export async function setupGen1Project(projRoot: string, projectName: string) { |
There was a problem hiding this comment.
Suggested change
| export async function setupGen1Project(projRoot: string, projectName: string) { | |
| export async function setupAndPushGen1Project(projRoot: string, projectName: string) { |
push is heavy long running operation. please be explicit in function name.
Comment on lines
118
to
136
| function removeNestedJsonKeys<T extends Record<string, unknown>>(obj: T, keysToRemove: string[]): T { | ||
| const result = { ...obj }; | ||
| keysToRemove.forEach((path) => { | ||
| const parts = path.split('.'); | ||
| let current: Record<string, unknown> = result; | ||
| for (let i = 0; i < parts.length - 1; i++) { | ||
| const part = parts[i]; | ||
| if (current[part] === undefined || current[part] === null) { | ||
| return; // Path doesn't exist, nothing to delete | ||
| } | ||
| current = current[part] as Record<string, unknown>; | ||
| } | ||
| const lastPart = parts[parts.length - 1]; | ||
| if (current && lastPart in current) { | ||
| delete current[lastPart]; | ||
| } | ||
| }); | ||
| return result; | ||
| } |
There was a problem hiding this comment.
I think we have lodash in the node_modules.
if we do, consider using https://lodash.com/docs/4.17.15#unset instead.
Comment on lines
145
to
151
| export async function migrateCodegen(projRoot: string) { | ||
| await assert.doesNotReject(runCodegenCommand(projRoot), 'Codegen failed'); | ||
| } | ||
|
|
||
| export async function deployGen2Sandbox(projRoot: string) { | ||
| await assert.doesNotReject(runGen2SandboxCommand(projRoot), 'Gen2 CDK deployment failed'); | ||
| } |
There was a problem hiding this comment.
Suggested change
| export async function migrateCodegen(projRoot: string) { | |
| await assert.doesNotReject(runCodegenCommand(projRoot), 'Codegen failed'); | |
| } | |
| export async function deployGen2Sandbox(projRoot: string) { | |
| await assert.doesNotReject(runGen2SandboxCommand(projRoot), 'Gen2 CDK deployment failed'); | |
| } | |
| export async function assertMigrateCodegen(projRoot: string) { | |
| await assert.doesNotReject(runCodegenCommand(projRoot), 'Codegen failed'); | |
| } | |
| export async function assertDeploysGen2Sandbox(projRoot: string) { | |
| await assert.doesNotReject(runGen2SandboxCommand(projRoot), 'Gen2 CDK deployment failed'); | |
| } |
Or just get rid of these functions and have run.. and assertions inline in relevant tests. (I'd just inline this, these functions seem too small).
sobolk
approved these changes
Oct 1, 2024
abhi7cr
approved these changes
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
npx @aws-amplify/migrate to-gen-2 generate-codenpx ampx sandboxyarn e2e-migrationfrom the rootDescription of how you validated changes
Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.