test(unify): Settings e2e tests #19324
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -8,95 +8,91 @@ describe('App: Settings', { viewportWidth: 600 }, () => { | |
| cy.startAppServer('e2e') | ||
| }) | ||
|
|
||
| it('visits settings page', () => { | ||
| cy.visitApp() | ||
| cy.findByText('Settings').click() | ||
|
|
||
| cy.get('div[data-testid="header-bar"]').should('contain', 'Settings') | ||
| cy.findByText('Device Settings').should('be.visible') | ||
| cy.findByText('Project Settings').should('be.visible') | ||
| }) | ||
|
|
||
| it('can reconfigure a project', () => { | ||
| cy.visitApp('#settings') | ||
|
|
||
| cy.intercept('mutation-SettingsContainer_ReconfigureProject', { 'data': { 'reconfigureProject': true } }).as('ReconfigureProject') | ||
| cy.findByText('Reconfigure Project').click() | ||
| cy.wait('@ReconfigureProject') | ||
| }) | ||
|
|
||
| describe('external editor', () => { | ||
| beforeEach(() => { | ||
| cy.withCtx(async (ctx) => { | ||
| ctx.coreData.localSettings.availableEditors = [ | ||
| ...ctx.coreData.localSettings.availableEditors, | ||
| // don't rely on CI machines to have specific editors installed | ||
| // so just adding one here | ||
| { | ||
| id: 'well-known-editor', | ||
| binary: '/usr/bin/well-known', | ||
| name: 'Well known editor', | ||
| }, | ||
| ] | ||
|
|
||
| ctx.coreData.localSettings.preferences.preferredEditorBinary = undefined | ||
| }) | ||
|
|
||
| cy.visitApp('#settings') | ||
| cy.contains('Device Settings').click() | ||
| }) | ||
|
|
||
| it('selects well known editor', () => { | ||
| cy.intercept('POST', 'mutation-ExternalEditorSettings_SetPreferredEditorBinary').as('SetPreferred') | ||
|
|
||
| cy.contains('Choose your editor...').click() | ||
| cy.contains('Well known editor').click() | ||
| cy.wait('@SetPreferred').its('request.body.variables.value').should('include', '/usr/bin/well-known') | ||
|
|
||
| // navigate away and come back | ||
| // preferred editor selected from dropdown should have been persisted | ||
| cy.visitApp() | ||
| cy.get('[href="#/settings"]').click() | ||
| cy.wait(100) | ||
| cy.get('[data-cy="Device Settings"]').click() | ||
|
|
||
| cy.get('[data-cy="use-well-known-editor"]').should('be.checked') | ||
| cy.get('[data-cy="use-custom-editor"]').should('not.be.checked') | ||
| }) | ||
|
|
||
| it('allows custom editor', () => { | ||
| cy.intercept('POST', 'mutation-ExternalEditorSettings_SetPreferredEditorBinary').as('SetPreferred') | ||
|
|
||
| // doing invoke instead of `type` since `type` enters keys on-by-one, triggering a mutation | ||
| // for each keystroke, making it hard to intercept **only** the final request, which I want to | ||
| // assert contains `/usr/local/bin/vim' | ||
| cy.findByPlaceholderText('Custom path...').clear().invoke('val', '/usr/local/bin/vim').trigger('input').trigger('change') | ||
| cy.wait('@SetPreferred').its('request.body.variables.value').should('include', '/usr/local/bin/vim') | ||
|
|
||
| // navigate away and come back | ||
| // preferred editor entered from input should have been persisted | ||
| cy.get('[href="#/settings"]').click() | ||
| cy.wait(100) | ||
| cy.get('[data-cy="Device Settings"]').click() | ||
|
|
||
| cy.get('[data-cy="use-well-known-editor"]').should('not.be.checked') | ||
| cy.get('[data-cy="use-custom-editor"]').should('be.checked') | ||
| cy.get('[data-cy="custom-editor"]').should('have.value', '/usr/local/bin/vim') | ||
| }) | ||
|
|
||
| it('lists file browser as available editor', () => { | ||
| cy.intercept('POST', 'mutation-ExternalEditorSettings_SetPreferredEditorBinary').as('SetPreferred') | ||
|
|
||
| cy.contains('Choose your editor...').click() | ||
| cy.get('[data-testid="computer"]').click() | ||
|
||
|
|
||
| cy.wait('@SetPreferred').its('request.body.variables.value').should('include', 'computer') | ||
| cy.get('[data-cy="use-well-known-editor"]').should('be.checked') | ||
| cy.get('[data-cy="use-custom-editor"]').should('not.be.checked') | ||
| }) | ||
| }) | ||
| }) | ||
This file contains hidden or 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 hidden or 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,25 @@ | ||
| import CopyButton from './CopyButton.vue' | ||
|
|
||
| describe('<CopyButton />', { viewportHeight: 450, viewportWidth: 350 }, () => { | ||
| it('copies text to clipboard', () => { | ||
| cy.mount(() => (<> | ||
| <CopyButton text="Foobar" /> | ||
| </>)) | ||
| .get('button') | ||
| .should('contain.text', 'Copy') | ||
|
|
||
| .get('svg') | ||
| .should('exist') | ||
|
|
||
| // This button is broken on Firefox, but works properly on Chromium/Chrome/Electron | ||
| // TODO: Add assertions about actually clicking the button. | ||
| }) | ||
|
|
||
| it('noIcon hides the icon', () => { | ||
| cy.mount(() => (<> | ||
| <CopyButton text="Foobar" noIcon={true} /> | ||
| </>)) | ||
| .get('svg') | ||
| .should('not.exist') | ||
| }) | ||
| }) |
This file contains hidden or 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
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.
We should use the
defaultMessageswhen we can i.e.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.
This is something I always struggle with when writing tests - it feels strange to be importing values to test against.
On the one hand, there's less duplication of strings, and if the string changes, then we don't have to update the test. We try to avoid embedding strings in code for good reasons, and some of those reasons apply to embedding strings in tests too.
On the other hand, if the string changes... the behavior has changed and wouldn't we want the test to point that out? If I replaced
noEditorSelectedPlaceholderwith an empty string in the localization, the test would still pass despite not showing what we expected to the user.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.
That's a fair point. Plus, it makes the test a bit harder to read since I don't know exactly what DOM element it's trying to find, I either have to wait for the test to run or dig through the json. I think this is a good point to bring up to the team since we aren't consistent either way
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.
I agree with @BlueWinds - I don't think it makes sense to assert against the same thing we test against. You could changing the string in en-US.json to some random junk and it would still pass.
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.
For anyone following along at home, we've started a discussion in Slack about this, currently waiting for Jess to return and give her opinion on the matter before deciding which direction to go.