Migrate XWiki using Distribution Wizard

Last modified by Ilie Andriuta on 2024/04/03 12:34

Home Upgrade tests Home Run Test

Steps to reproduce

  1. Create/access an older version of XWiki
  2. Create a subwiki
  3. Create a Nested Page and a Terminal Page with some content in both Main Wiki (e.g. PageN.WebHome and PageN.PageT) and subwiki (e.g. PageNS.WebHome and PageNS.PageTS)
  4. Add some attachments on both Nested Pages and Terminal Pages
  5. Add a large sized attachment (min 200 MB)
  6. Add an attachment having spaces in its name
  7. Add an Office files attachment
  8. Delete some attachments from both Nested Page and Terminal Page
  9. Create a Nested Page and a Terminal Page, add an attachment on each of them and then delete the pages
  10. Add some comments on some pages
  11. To test migration of Untyped links, edit a page and insert the following in Wiki/Source mode:
    - for the page located on Main Wiki:
    [[subwiki:PageNS.WebHome]] [[subwiki:PageNS.PageTS]]
    - for the page located on subwiki:
    [[xwiki:PageN.WebHome]] [[xwiki:PageN.PageT]]
  12. Create some users in Main Wiki and subwiki
  13. Add an user from Main Wiki to be a member of the subwiki
  14. Install an extension (can be different) on both Main Wiki and subwiki (with some entries, if applicable)
  15. Enable Notifications for an user (e.g. on Main Wiki) or more
  16. Perform some events (e.g. create, edit, comment) to generate some notifications for this user(s)
  17. Mark some events as read from Notifications List
  18. Stop XWiki
  19. Unzip/install the newer version of XWiki (to which the migration will be made)
  20. Go to the newer instance and copy/cut the [...]webapps\xwiki folder and replace it (first delete the old one) in the same location on the older version
    (on Jetty - XWiki Standalone packaging a better practice is to copy old data folder and replace it in the new Jetty setup)
  21. Start XWiki
  22. Login as Admin
  23. Use the Distribution Wizard to complete the upgrade process
  24. After upgrade, open Notifications List of the regular user(s) as well as for the Admin
  25. Observe the events listed
  26. Observe the Notification filters for both Admin and regular user(s)
  27. Go to the previously created Nested and Terminal pages on both Main Wiki and subwiki
  28. Click on the attachments (also on LiveData for attachments, click on Next Page - Previous Page to test pagination)
  29. On Applications Panel, click on the installed application and check the entries on both Main Wiki and subwiki
  30. Go to page Index > Deleted Pages and observe the table entries on both Main Wiki and subwiki
  31. Click on the deleted page(s)
  32. Go to Page Index > Deleted Attachments and observe the table entries on both Main Wiki and subwiki
  33. Click on the deleted attachment(s)
  34. Go to User Index on both Main Wiki and subwiki and observe the entries (on subwiki see the global users as well as the local users)
Information

NOTE: If upgrading to XWiki 11.4 and higher (from instances older than 11.4), the 'solr' folder must be deleted from the configured permanent directory of the XWiki instance in order for the Solr search to work. The Solr index will be deleted as a result but it will be recreated automatically and the entire wiki will be re-indexed after a server restart (see Release Notes for XWiki 11.4)
Starting XWiki 11.8 deleting of 'solr' folder manually is not necessary, since the migration is automated

Warning

NOTE: Starting 14.1 RC1, the underlying implementation of the Mentions Application, H2 MVStore is now replaced by the newly introduced Asynchronous document static analysis module. When upgrading to 14.1RC1+ the H2 MVStore files are not used anymore.
Consequently, any updated document queued for upgrade when the server is stopped will be discarded, and some users will not be notified of their mentions.
Please make sure that the queue size is at zero before upgrading (see JMX).

Warning

NOTE: If upgrading to XWiki 14.6 and up from a version of XWiki older than 12.4 you will need to migrate events (notifications) if you don't want them to appear lost. There used to be a step proposing it in the Distribution Wizard and this step was removed but you can still ask for a migration from the wiki administration (Administer Wiki -> Social -> Notifications -> Events migration), see Release Notes for XWiki 14.6

Expected results

- The older XWiki version (including created subwiki and pages) are properly migrated to the new version;
- The notifications are migrated properly (unless there are some exceptions, see the Warning notes above and also starting with XWiki 15.5 RC1 there are some specific issues as can be seen in Release Notes for XWiki 15.5 RC1
- The filter preferences are migrated (if the case)
- The attachments from both Nested and Terminal pages can be accessed/viewed properly on both Main Wiki and subwiki (including the ones with spaces in the name)
- The pagination works on LiveData for attachments
- The application(s) installed contains the migrated entries
- The deleted pages are displayed in the table and can be accessed on both Main Wiki and subwiki and contain the attachment (but cannot be seen ATM)
- The deleted attachments are displayed in the table and can be accessed on both Main Wiki and subwiki
- On Main Wiki, in User Index are displayed Admin and the global user(s)
- On subwiki, in User Index are displayed the local user(s) and the global user(s) which are members of that subwiki

Results

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

Get Connected