Editor entry tests #1408

JeanneSon · 2022-05-23T10:58:36Z

Description

Summary

These tests test

functioning of the entries list
functioning of the entry editor
- entries are correct (corresponding to the set-up of the entries)
- changing the visibility of empty fields
- uploading and displaying pictures
- audio (also for different user roles)
- entries with multiple definitions or meanings
- creating a new entry
- configurations of writing system visibility

Details

The following tests have been converted to playwright

Lexicon E2E Editor List and Entry

✓ setup: login, click on test project
✓ browse page has correct word count
✓ search function works correctly
✓ click on first word
✓ edit page has correct word count
✓ word 1: edit page has correct definition, part of speech
✓ add citation form as visible field
✓ citation form field overrides lexeme form in dictionary citation view
✓ one picture and caption is present
✓ file upload drop box is displayed when Add Picture is clicked
✓ audio Input System is present, playable and has "more" control (manager)
✓ word 2: audio Input System is not playable but has "upload" button (manager)
✓ audio Input System is present, playable and has "more" control (member)
✓ word 2: audio Input System is not playable but has "upload" button (member)
✓ audio Input System is playable but does not have "more" control (observer)
✓ word 2: audio Input System is not playable and does not have "upload" button (observer)
✓ can delete audio Input System

✓ word 2: edit page has correct definition, part of speech
✓ dictionary citation reflects example sentences and translations
✓ word with multiple definitions: edit page has correct definitions, parts of speech
✓ word with multiple meanings: edit page has correct example sentences, translations
✓ while Show Hidden Fields has not been clicked, hidden fields are hidden if they are empty
✓ word with multiple meanings: edit page has correct general notes, sources
✓ senses can be reordered and deleted
✓ check that Semantic Domain field is visible (for view settings test later)

For details/remarks regarding converting the above tests, refer to the spreadsheet; https://docs.google.com/spreadsheets/d/1w9wjfm-02QHLhv0ObPAKKlqnDWeag379GIXwOcRU4W0/edit#gid=0

Added
✓ Navigate to other entries with left entry bar

Duplicate / not needed in Playwright and hence dropped
✓ refresh returns to list view
✓ refresh returns to entry view
✓ click on second word (found by definition)
✓ login as member, click on first word
✓ click on second word (found by definition)
✓ login as observer, click on first word
✓ click on second word (found by definition)
✓ login as manager, click on first word
✓ file upload drop box is displayed when Upload is clicked
✓ file upload drop box is not displayed when Cancel Uploading Audio is clicked
✓ click on second word (found by definition)
✓ setup: click on word with multiple definitions (found by lexeme)

These tests were merged with other tests
✓ dictionary citation reflects lexeme form -> Citation form field overrides lexeme form in dictionary citation view
✓ file upload drop box is not displayed when Cancel Adding Picture is clicked -> File upload drop box is displayed when Add Picture is clicked and can be cancelled
✓ change config to show Pictures and hide captions -> Can change config to show pictures and hide empty captions & can change config to show empty captions
✓ caption is hidden when empty if "Hidden if empty" is set in config -> Can change config to show pictures and hide empty captions & can change config to show empty captions
✓ change config to show Pictures and show captions -> Can change config to show pictures and hide empty captions & can change config to show empty captions
✓ when caption is empty, it is visible if "Hidden if empty" is cleared in config -> Can change config to show pictures and hide empty captions & can change config to show empty captions
✓ picture is removed when Delete is clicked -> Picture is removed when Delete is clicked & can change config to hide pictures and hide captions
✓ change config to hide Pictures and hide captions -> Picture is removed when Delete is clicked & can change config to hide pictures and hide captions
✓ while Show Hidden Fields has not been clicked, Pictures field is hidden -> Picture is removed when Delete is clicked & can change config to hide pictures and hide captions
✓ file upload drop box is displayed when Upload is clicked -> File upload drop box is displayed when Upload is clicked & not displayed if upload cancelled
✓ file upload drop box is not displayed when Cancel Uploading Audio is clicked -> File upload drop box is displayed when Upload is clicked & not displayed if upload cancelled
Mock file upload
✓ can't upload a non-audio file -> Can't upload a non-audio file & can upload audio file
✓ can upload an audio file -> Can't upload a non-audio file & can upload audio file
✓ back to browse page, create new word -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list
✓ check that word count is still correct -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list
✓ modify new word -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list
✓ autosaves changes -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list
✓ new word is visible in edit page -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list
Configuration check
✓ Word has only "th", "tipa" and "taud" visible -> Can change configuration to make a writing system visible or invisible
✓ make "en" input system visible for "Word" field -> Can change configuration to make a writing system visible or invisible
✓ Word has "th", "tipa", "taud" and "en" visible -> Can change configuration to make a writing system visible or invisible
✓ make "en" input system invisible for "Word" field -> Can change configuration to make a writing system visible or invisible
✓ Word has only "th", "tipa" and "taud" visible again -> Can change configuration to make a writing system visible or invisible
✓ make "taud" input system invisible for "Word" field and "tipa" invisible for manager role -> Make "taud" input system invisible for "Word" field and "tipa" invisible for manager role, then ensure it worked and change it back
✓ Word has only "th" visible -> Make "taud" input system invisible for "Word" field and "tipa" invisible for manager role, then ensure it worked and change it back
✓ restore visibility of "taud" for "Word" field -> Make "taud" input system invisible for "Word" field and "tipa" invisible for manager role, then ensure it worked and change it back
✓ Word has only "th" and "taud" visible for manager role -> Make "taud" input system invisible for "Word" field and "tipa" invisible for manager role, then ensure it worked and change it back
✓ restore visibility of "tipa" input system for manager role -> Make "taud" input system invisible for "Word" field and "tipa" invisible for manager role, then ensure it worked and change it back
✓ Word has "th", "tipa" and "taud" visible again for manager role -> Make "taud" input system invisible for "Word" field and "tipa" invisible for manager role, then ensure it worked and change it back
✓ new word is visible in browse page -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list
✓ check that word count is still correct in browse page -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list
✓ remove new word to restore original word count -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list
✓ previous entry is selected after delete -> Back to browse page, create new word, check word count, modify new word, autosaves changes, new word visible in editor and list

Type of Change

E2E test

Screenshots

Checklist

I have performed a self-review of my own code
I have reviewed the title/description of this PR which will be used as the squashed PR commit message
I have commented my code, particularly in hard-to-understand areas
I have added tests that prove my fix is effective or that my feature works

github-actions · 2022-05-23T11:00:43Z

Unit Test Results

368 tests 368 ✔️ 13s ⏱️
    1 suites     0 💤
    1 files     0 ❌

Results for commit effc032.

♻️ This comment has been updated with latest results.

Can't use the LexUploadCommands methods after all, as they expect PHP's special $_FILES array to exist, and user code can't touch that array. So we copy the guts of those methods into TestControl.php instead.

Usage: add_writing_system_to_project('testlangproj', 'th-Zxxx-x-audio')

We'll use a shared folder instead of trying to handle uploads in PHP

Got the path slightly wrong earlier

The project model was being updated with the user, but the user model wasn't being updated with the project, resulting in the share dialog not finding the user as a project member. Fixed now.

The protractor tests test navigation from one entry to another implicitly. Playwright directly jumps to an entry to test it. Therefore, an explicite test for navigating from one entry to another using the side bar on the left was added.

test/e2e/pages/configuration.page.ts

JeanneSon · 2022-09-06T13:55:13Z

I just wanted to mention that the execution of this test file is very slow due to the number of reloads. The only way I could manage to ensure that a page was fully loaded was by including a waitForTimeout. This should be replaced by another solution in the future.

megahirt

This is an EPIC PR! Great job @JeanneSon and @rmunn !

JeanneSon self-assigned this May 23, 2022

JeanneSon added the testing Pertaining to unit or e2e testing label May 25, 2022

JeanneSon force-pushed the chore/editorEntryTests branch from 473dcf8 to cac9cbe Compare June 27, 2022 10:45

JeanneSon changed the title ~~Chore/editor entry tests~~ Editor entry tests Jun 28, 2022

josephmyers assigned rmunn Jul 5, 2022

megahirt force-pushed the chore/editorEntryTests branch from cac9cbe to 0702f4e Compare September 5, 2022 09:28

rmunn and others added 13 commits September 5, 2022 16:30

Improve function adding lexical entries

69ce8ec

Convert about a third of the editor tests

45938e5

Add testSeup API to add media files to a project

4ce42bf

Fix uploading media files

d2a53fe

Fix uploading media files

f15d602

Can't use the LexUploadCommands methods after all, as they expect PHP's special $_FILES array to exist, and user code can't touch that array. So we copy the guts of those methods into TestControl.php instead.

Allow adding writing systems to test projects

4becc12

Usage: add_writing_system_to_project('testlangproj', 'th-Zxxx-x-audio')

Fix PHP error in testSetup file upload functions

c7e275d

Change how we copy media files to E2E container

e02fa0c

We'll use a shared folder instead of trying to handle uploads in PHP

Fix copying media files to E2E container

7cf606f

Got the path slightly wrong earlier

Convert more editor tests

69f22d4

Fix adding users to projects

34beea5

The project model was being updated with the user, but the user model wasn't being updated with the project, resulting in the share dialog not finding the user as a project member. Fixed now.

Finish editor test conversion, not yet cleaned-up

35430f2

Clean-up editor entry tests

746caa1

megahirt force-pushed the chore/editorEntryTests branch from 0702f4e to 746caa1 Compare September 5, 2022 09:30

JeanneSon added 4 commits September 5, 2022 14:06

Fix failing test

258d841

Add test testing navigation to other entries

b012363

The protractor tests test navigation from one entry to another implicitly. Playwright directly jumps to an entry to test it. Therefore, an explicite test for navigating from one entry to another using the side bar on the left was added.

Fix some TODOs

1f0172e

Add comments for understanding; clean-up

effc032

JeanneSon commented Sep 6, 2022

View reviewed changes

test/e2e/pages/configuration.page.ts Show resolved Hide resolved

JeanneSon marked this pull request as ready for review September 6, 2022 14:02

JeanneSon requested a review from megahirt September 6, 2022 14:03

megahirt approved these changes Sep 8, 2022

View reviewed changes

JeanneSon merged commit 11e1709 into develop Sep 8, 2022

JeanneSon deleted the chore/editorEntryTests branch September 8, 2022 10:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Editor entry tests #1408

Editor entry tests #1408

JeanneSon commented May 23, 2022 •

edited

Loading

github-actions bot commented May 23, 2022 •

edited

Loading

JeanneSon commented Sep 6, 2022

megahirt left a comment

Editor entry tests #1408

Editor entry tests #1408

Conversation

JeanneSon commented May 23, 2022 • edited Loading

Description

Summary

Details

Type of Change

Screenshots

Checklist

github-actions bot commented May 23, 2022 • edited Loading

Unit Test Results

JeanneSon commented Sep 6, 2022

megahirt left a comment

Choose a reason for hiding this comment

JeanneSon commented May 23, 2022 •

edited

Loading

github-actions bot commented May 23, 2022 •

edited

Loading