Test Plan for Realtime WYSIWYG Editor

Last modified by Ilie Andriuta on 2026/02/09 16:52

Home CKEditor Home Run Test

Steps to reproduce

Information

NOTE: this is a work in progress!

The Realtime WYSIWYG Editor feature was integrated in product in XWiki 16.2.0 and backported to XWiki 15.10.10

Detailed information about this functionality can be found here

Issues known for CKEditor Realtime feature

NOTE: This Test Plan was validated with Marius Florea to see which tests are automated.

Verify that users editing in WYSIWYG Realtime can:

  1. edit the same paragraph (including inserting emoticons, insert special characters, etc)
  2. cut, copy and paste text
  3. drag & drop images and other files
  4. insert images, upload images and images with captions, edit same caption
  5. insert macros, edit same macro
  6. insert tables, edit same table, same cell
  7. format same text

Tests:

  1. Enable realtime collaboration for the WYSIWYG editor [AUTOMATED]
    • As Admin click on Drawer > Administer Wiki > Editing > WYSIWYG Editor
    • Remove (uncheck) the "xwiki-realtime" from the list of disabled plugins in the CKEditor administration section
    • Click on the Save button
    • Edit any page
      Expected results: 'Allow Realtime Collaboration' appears when editing a document with CKEditor and is checked / activated.
  2. At least 2 users edit the same page by adding some text at the same time using Realtime Collaboration [AUTOMATED]
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Add some text
    • Switch to the window of the first user (user01) and add some text
    • Click Save & View
    • Switch back to the private window of the second user (user02)
    • Add some text
    • Click "Done" button
      Expected results: The entire content is saved, including the new text added by the users.
  3. At least 2 users edit the same page by adding some images, files at the same time using Realtime Collaboration [AUTOMATED, except for file drag & drop]
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Add a new image (click on Image > Upload > add any image > Upload > Select > Tick Caption > Insert)
    • Type a Caption for the image
    • Switch to the window of the first user (user01)
    • Add some text then drag and drop a file (ex. pdf or office files)
    • Click "Done" button
    • Switch back to the private window of the second user (user02) and click "Done" button
      Expected results: The entire content is saved, including the image and file added.
  4. At least 2 users edit the same page by changing / formatting some text at the same time using Realtime Collaboration [AUTOMATED]
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Make changes to any text (ex. bold, italic, add links to xwiki pages or URL's)
    • Switch to the window of the first user (user01) and do the same
    • Click "Done" button
    • Switch back to the private window of the second user (user02) and click Save & View
      Expected results: The entire content is saved, including the changes done by the users.
  5. At least 2 users edit the same page by removing some text at the same time using Realtime Collaboration [AUTOMATED]
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Remove some/all text
    • Switch to the window of the first user (user01) and add some text
    • Click "Done" button
    • Switch back to the private window of the second user (user02) and click Save & View
      Expected results: All changes are saved.
  6. At least 2 users edit the same page at the beginning, one of them adding some content then Save & Viewing the page (leaving the collaboration) and the other user remaining and adding more content [AUTOMATED]
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Add some content: text, images, tables, links, files, emojies
    • Switch to the window of the first user (user01) and add some content
    • Click "Done" button
    • Switch back to the private window of the second user (user02) - Only the current editing user's avatar would appear at this point
    • Add some content
    • Click "Done" button
      Expected results: All changes are saved.
  7. At least 2 users edit the same page at the beginning, one of them changing an image / link to a page or formatting some text then Save & Viewing the page (leaving the collaboration) and the other user remaining making the same changes
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Format any text ex. select a/some word/s and select italic, bold, Headings, strikethrough, underline (or change an image / link to a page)
    • Switch to the window of the first user (user01) and change an image / link to a page / format text
    • Click "Done" button
    • Switch back to the private window of the second user (user02) - Only the current editing user's avatar would appear at this point
    • Make any of the changes stated above
    • Click "Done" button
      Expected results: All changes are saved.
  8. At least 2 users edit the same page at the beginning, one of them removing some content then Save & Viewing the page (leaving the collaboration) and the other user remaining adding some new content/making changes 
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Add some content / make some formatting changes
    • Switch to the window of the first user (user01) and remove all content
    • Click "Done" button (click Save on Merge conflict if it's displayed)
    • Switch back to the private window of the second user (user02) - only his avatar would appear at this point since he's editing alone
    • Add any content
    • Click "Done" button
      Expected results: All changes are saved.
  9. At least 2 users edit the same page at the beginning, one of them adding some content, unticking the "Allow Realtime Collaboration" (leaving the collaboration) and adding more content then Save & Viewing the page, and the other user remaining in Realtime editing and adding some new content/making changes  [AUTOMATED]
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Add some content / make some changes
    • Switch to the window of the first user (user01) and add some content
    • Untick the "Allow Realtime Collaboration"
    • Click on the "Leave the collaborative session" button
    • Add more content
    • Click "Done" button
    • Switch back to the private window of the second user (user02) - Editing alone would appear at this point
    • Add any content
    • Click "Done" button
      Expected results: All changes are saved (click Save on Merge conflict if it's displayed).
  10. At least 2 users edit the same page which contains at least a macro, using Realtime Collaboration [AUTOMATED]
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Add a paragraph
    • Add a macro ex. Info / Success / Warning / Error macro
    • Start adding some text in it
    • Switch to the window of the first user (user01)
    • Change the text in the macro and some other text
    • Click "Done" button
    • Switch back to the private window of the second user (user02)
    • Click "Done" button
      Expected results: The entire content is saved, including the changes made in the macro.
  11. All users avatars appear at the beginning of the row when they are editing the same line. [AUTOMATED, but for different edited lines]
    • As a simple user (user01) edit any page
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Add some text
    • Switch to the window of the first user (user01) and add some text on the same line
      Expected results: All the users avatars that are editing the same line appear at the beginning of the row.
  12. Show connected users - The names and avatars of the users that are also editing in Realtime appear on top of the Menu section, after "Editing with:" [AUTOMATED] - [DEPRECATED]
    • As a simple user (user01) edit any page and add some text
    • Open a new private (incognito) browser window and login with another simple user (user02)
    • Access the same page and edit it, forcing the lock (if the case)
    • Add some text
      Expected results: On top of the menu the names and avatars of the other users that are editing the page in Realtime appear - this is because, by default, SHOW CONNECTED USERS - Display both user names and avatars is selected in Administration.
  13. Show connected users - Display only user names - [DEPRECATED]
    • As Admin click on Drawer > Administer Wiki > Editing > Realtime Editors
    • Select "Display only user names" under Show Connected Users
    • Click on the Save button
    • Edit any page ex. Sandbox 
    • Click in the content of the page
    • Open a new private (incognito) browser window and login with a simple user (user01)
    • Access the same page and edit it, forcing the lock (if the case)
    • Click in the content of the page
      Expected results: On top of the menu the user names of the other users that are editing the page in Realtime appear.
  14. Show connected users - Display only user avatars - [DEPRECATED]
    • As Admin click on Drawer > Administer Wiki > Editing > Realtime Editors
    • Select "Display only user avatars" under Show Connected Users
    • Click on the Save button
    • Edit any page ex. Sandbox 
    • Click in the content of the page
    • Open a new private (incognito) browser window and login with a simple user (user01)
    • Access the same page and edit it, forcing the lock (if the case)
    • Click in the content of the page
      Expected results: On top of the menu the user avatars of the other users that are editing the page in Realtime appear.
  15. "Show Editing Users" unchecked - [DEPRECATED]
    • As Admin click on Drawer > Administer Wiki > Editing > Realtime Editors
    • Uncheck "SHOW EDITING USERS"
    • Click on the Save button
    • Edit any page ex. Sandbox 
    • Click in the content of the page
    • Open a new private (incognito) browser window and login with a simple user (user01)
    • Access the same page and edit it, forcing the lock (if the case)
    • Click in the content of the page
      Expected results: Nothing appears in the left side of each edited line.

Expected results

Results

per page of Page
Jira Issue
Warning
The environment prevents the table from loading data.
 
Page

Get Connected