-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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
test: add e2e tests for CTB restarts from file changes #19801
Merged
Merged
Changes from 24 commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
4314943
doc: update e2e test docs
innerdvations b718823
fix: allow args to pass through to playwright
innerdvations a88266a
test: move transfer token tests
innerdvations 3798695
test: init ctb tutorial test
innerdvations 55f5cf9
test: init create collection type test
innerdvations b607cec
test: add waitForRestart
innerdvations a611443
test: add custom timeout to restart
innerdvations ad52634
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations 152443c
chore: update comment
innerdvations d6b62b2
enhancement: handle file system state management
innerdvations 4429aee
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations 4e518f2
fix: add fake git user for test-apps
innerdvations 6f8e577
test: fix import path
innerdvations 28c3a85
test: add cleanup
innerdvations 4c81f51
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations 5a65184
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations 1af9820
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations 9679c71
test: remove page from afterAll
innerdvations dfc5496
test: comment
innerdvations ae781e9
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations aa5bfaa
chore: refactor utils
innerdvations b1b5606
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations e42b1b5
fix: move delay to util
innerdvations 0f9a701
Merge branch 'chore/e2e-ctb-tests' of https://github.com/strapi/strap…
innerdvations 9d4d67e
docs: info on running individual files
innerdvations 101d2da
fix: add fallback page reload
innerdvations 0c2a5f0
fix: check strapi is defined
innerdvations 718fd2c
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations 6c67881
Merge branch 'develop' into chore/e2e-ctb-tests
innerdvations File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,95 +1,4 @@ | ||
const { | ||
file: { | ||
providers: { createLocalFileDestinationProvider }, | ||
}, | ||
strapi: { | ||
providers: { createLocalStrapiSourceProvider }, | ||
}, | ||
engine: { createTransferEngine }, | ||
} = require('@strapi/data-transfer'); | ||
const strapiFactory = require('@strapi/strapi'); | ||
const { ALLOWED_CONTENT_TYPES } = require('../constants'); | ||
|
||
/** | ||
* Export the data from a strapi project. | ||
* This script should be run as `node <path-to>/dts-export.js [exportFilePath]` from the | ||
* root directory of a strapi project e.g. `/examples/kitchensink`. Remember to import | ||
* the `with-admin` tar file into the project first because the tests rely on the data. | ||
*/ | ||
const exportData = async () => { | ||
let args = process.argv.slice(2); | ||
|
||
if (args.length !== 1) { | ||
console.error('Please provide the export file name as a parameter.'); | ||
process.exit(1); | ||
} | ||
|
||
const strapi = await createStrapiInstance(); | ||
|
||
const source = createSourceProvider(strapi); | ||
const destination = createDestinationProvider(args[0]); | ||
|
||
const engine = createTransferEngine(source, destination, { | ||
versionStrategy: 'ignore', // for an export to file, versionStrategy will always be skipped | ||
schemaStrategy: 'ignore', // for an export to file, schemaStrategy will always be skipped | ||
only: ['content', 'files'], | ||
transforms: { | ||
links: [ | ||
{ | ||
filter(link) { | ||
return ( | ||
ALLOWED_CONTENT_TYPES.includes(link.left.type) && | ||
ALLOWED_CONTENT_TYPES.includes(link.right.type) | ||
); | ||
}, | ||
}, | ||
], | ||
entities: [ | ||
{ | ||
filter(entity) { | ||
return ALLOWED_CONTENT_TYPES.includes(entity.type); | ||
}, | ||
}, | ||
], | ||
}, | ||
}); | ||
|
||
engine.diagnostics.onDiagnostic(console.log); | ||
|
||
try { | ||
const results = await engine.transfer(); | ||
|
||
console.log(JSON.stringify(results.engine, null, 2)); | ||
} catch { | ||
console.error('Export process failed.'); | ||
process.exit(1); | ||
} | ||
|
||
process.exit(0); | ||
}; | ||
|
||
const createSourceProvider = (strapi) => | ||
createLocalStrapiSourceProvider({ | ||
async getStrapi() { | ||
return strapi; | ||
}, | ||
}); | ||
|
||
const createDestinationProvider = (filePath) => | ||
createLocalFileDestinationProvider({ | ||
file: { path: filePath }, | ||
encryption: { enabled: false }, | ||
compression: { enabled: false }, | ||
}); | ||
|
||
const createStrapiInstance = async (logLevel = 'error') => { | ||
const appContext = await strapiFactory.compile(); | ||
const app = strapiFactory(appContext); | ||
|
||
app.log.level = logLevel; | ||
const loadedApp = await app.load(); | ||
|
||
return loadedApp; | ||
}; | ||
const { exportData } = require('../utils/dts-export'); | ||
|
||
// TODO: make an actual yargs command and pass common options to exportData so it's easier to build the test data | ||
exportData(); |
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
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
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
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
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
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
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
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
56 changes: 56 additions & 0 deletions
56
tests/e2e/tests/content-type-builder/collection-type/create-collection-type.spec.ts
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
import { test, expect } from '@playwright/test'; | ||
import { login } from '../../../utils/login'; | ||
import { resetDatabaseAndImportDataFromPath } from '../../../utils/dts-import'; | ||
import { waitForRestart } from '../../../utils/restart'; | ||
import { resetFiles } from '../../../utils/file-reset'; | ||
|
||
test.describe('Create collection type', () => { | ||
test.beforeEach(async ({ page }) => { | ||
await resetFiles(); | ||
await resetDatabaseAndImportDataFromPath('with-admin.tar'); | ||
await page.goto('/admin'); | ||
await login({ page }); | ||
|
||
await page.getByRole('link', { name: 'Content-Type Builder' }).click(); | ||
|
||
// close the tutorial modal if it's visible | ||
const modal = page.getByRole('button', { name: 'Close' }); | ||
if (modal.isVisible()) { | ||
await modal.click(); | ||
await expect(modal).not.toBeVisible(); | ||
} | ||
}); | ||
|
||
// TODO: each test should have a beforeAll that does this, maybe combine all the setup into one util to simplify it | ||
// to keep other suites that don't modify files from needing to reset files, clean up after ourselves at the end | ||
test.afterAll(async () => { | ||
await resetFiles(); | ||
}); | ||
|
||
test('Can create a collection type', async ({ page }) => { | ||
await page.getByRole('button', { name: 'Create new collection type' }).click(); | ||
|
||
await expect(page.getByRole('heading', { name: 'Create a collection type' })).toBeVisible(); | ||
|
||
const displayName = page.getByLabel('Display name'); | ||
await displayName.fill('Secret Document'); | ||
|
||
const singularId = page.getByLabel('API ID (Singular)'); | ||
await expect(singularId).toHaveValue('secret-document'); | ||
|
||
const pluralId = page.getByLabel('API ID (Plural)'); | ||
await expect(pluralId).toHaveValue('secret-documents'); | ||
|
||
await page.getByRole('button', { name: 'Continue' }).click(); | ||
|
||
await expect(page.getByText('Select a field for your collection type')).toBeVisible(); | ||
await page.getByText('Small or long text').click(); | ||
await page.getByLabel('Name', { exact: true }).fill('myattribute'); | ||
await page.getByRole('button', { name: 'Finish' }).click(); | ||
await page.getByRole('button', { name: 'Save' }).click(); | ||
|
||
await waitForRestart(page); | ||
|
||
await expect(page.getByRole('heading', { name: 'Secret Document' })).toBeVisible(); | ||
}); | ||
}); |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
import { test, expect } from '@playwright/test'; | ||
import { login } from '../../utils/login'; | ||
import { resetDatabaseAndImportDataFromPath } from '../../utils/dts-import'; | ||
|
||
test.describe('Tutorial', () => { | ||
test.beforeEach(async ({ page }) => { | ||
await resetDatabaseAndImportDataFromPath('with-admin.tar'); | ||
await page.goto('/admin'); | ||
await login({ page }); | ||
}); | ||
|
||
test('Shows tutorial on first content type', async ({ page }) => { | ||
await page.getByRole('link', { name: 'Content-type Builder' }).click(); | ||
|
||
const modalHeader = page.getByRole('heading', { name: '🧠 Create a first Collection' }); | ||
expect(modalHeader).toBeVisible(); | ||
await modalHeader.click(); | ||
|
||
const closeButton = page.getByRole('button', { name: 'Close' }); | ||
expect(closeButton).toBeVisible(); | ||
await closeButton.click(); | ||
|
||
await expect(closeButton).not.toBeVisible(); | ||
await expect(modalHeader).not.toBeVisible(); | ||
}); | ||
}); |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why are you doing it afterAll but also in
beforeEach
? Maybe it should be inafterEach
instead?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a tricky question here.
In this file, the correct thing would be only the
beforeEach
(since each test makes changes) and then other suites would ensure on their own it was clean with a beforeAll/beforeEach as needed. But doing the filesystem reset is slow and only a couple suites make file changes (ctb and uploading), and I didn't want to update every other test file to do that.So I put the "bad" code (trying to clean up for other tests in afterAll is bad practice because you're not guaranteed it will run) separate even though it means we run it one extra time, because ultimately I want to remove it altogether once we have a faster method to detect/reset the files that would be ok to add universally.