Testing Guide for Equella 6.5-Stable


Please refer to the 6.5-Stable Release Notes for more details.

#104 Scripting pack

Now in the master docs repo. Self-creation of the javadoc in issues #105 and #106 (still pending)


  • TestLink: eqos-1936
  • Ensure the documentation is available and makes sense.

#98 / #102 Office Integration

Equella has the ability integrate with Microsoft Office products to enable a smoother editing experience. Due to licensing issues, and the inherit issues of using an older interop DLL on more modern installs of Office, the download of the Office Integration msi package has been removed from the Equella Web UI, and the DLLs in question have been removed from the git repo. The functionality is still useful, so conceptual documentation has been provided for users to build this functionality.


  • TestLink: eqos-1937, eqos-1938
  • Ensure the documentation is available and makes sense.
  • Ensure the download link has been removed from the Scrapbook > Upload files > ‘blue pulldown’ screen, and the new language makes sense.

#101 / Documentation / example files moved to the master docs repo


  • TestLink eqos-1939, eqos-1940
  • Ensure the documentation is linked in the main readme guides and makes sense.

#100 HTML Editor Plugins

Another documentation shift to the main docs repo.


  • TestLink eqos-1941 + regression tests flagged
  • Ensure the HTML plugins below are documented here.
    • after the deadline
    • ice
    • wiris
    • example plugin

#96 (Make installer set executable bit for files that need it)

After a Linux install, the sys admin no longer needs to chmod the jsvc, manager, and equellaserver scripts

Regression testing:

  • TestLink: Regression test flagged.
  • Install a fresh Equella instance, and then ensure you can start / stop the equellaserver and manager with your typical ‘Equella’ user without needing to run chmod.

#84 Re-implement file upload features

File uploads were re-implemented using AJAX instead of multipart and client side progress instead of server side.

Regression testing: TestLink eqos-1687->eqos-1698

  • Ensure progress bars still work
  • Make sure drag and drop still works
  • Ensure that any restrictions on file size and mime type still work (wizard control)

#56 (Remove dhfjava dependency)

The functionality was changed to not rely on dhfjava. Instead it uses a Tika open source library. The results are not as clean as dhfjava, so enhancements are welcome!

Functional testing:

  • Confirm the conversion service can be disabled
  • Confirm the conversion service can be enabled, and is usable

Performance testing:

  • Try converting a 10 MB file on 6.4-QA3, and compare the speed of the same file converted on 6.5-GA.

#72 (Allow configuration of the historically hardcoded donotreply@equella.com email address)

System admins now configure the ‘do not reply’ email address via the Server admin pages.

Functional testing: TetLink eqos-5343

  • Confirm the email address can be changed, and when an email is sent from Equella, the ‘do not reply’ sender field is set to the custom / configured email address.

#74 (Remove the UpgradeProxyWeb python server)

The functionality point the Equella Manager at a server that provides the latest Equella update has been removed.

Functional testing: TestLink: eqos-5341

  • Ensure the Equella Manager has no mention of an ‘upgrade server’

Regression testing: TestLink: Regression tests flagged.

  • Ensure the Equella Manager can still perform updates from a local upgrade binary.

#73 / #60 General build changes / scrubbing of commercial terminology

Hard-coded words denoting the last commercial owner and last commercial website of Equella were removed. Generally, resources (lang bundles and images) functionally haven’t changed, but how they are bundled into Equella did change.

Functional testing:

  • Ensure ‘Pearson’, and ‘equella.com’ don’t show up anywhere in the Equella application, and instead have been replaced by meaningful alternatives for the open source community.

Regression testing:

  • Ideally, review all places strings and images are presented to the user, and ensure no missing language strings (???my.lang.string???) or errors finding images occur.

#71 ( Allow configuration of LTI external tool contact for Equella )

When an LTI attachment was added to an item, at times it’s considered ‘default’, and historically, a default consumer contact email of support@equella.com was used. Now, you can configure this behavior by adding external.tool.contact.email into optional-config.properties.

Functional testing:

  • Ensure absent, blank, malformed email, and good email configured values work as expected in this userflow.

Regression testing:

  • Ensure previously configured ‘default’ LTI attachments have the expected consumer contact email when being edited.

#62 ( Upgrade flamingo )

Flamingo was upgraded to streamline dependencies from Maven.

Functional testing: TestLink eqos-3813

  • CRUD operations in the File Manager applet

#59 ( Replace use of hibernate-beanlib )

beanlib-hibernate was used for cloning a whole hibernate object tree but it had code which we no longer had the source too, so it was replaced with the use of xstream + special hibernate converters.

Regression testing: Regression tests tagged in TestLink

  • Clone a workflow
  • Clone an item (attachments and navigation tree in particular)
  • Import/Export/Clone an institution

#55 / #107 ( Kaltura licensing issues )

The Kaltura Java client API is not Apache-license-friendly. It was moved into it’s own repo, but can be integrated back into Equella per client by building the Equella and Kaltura source repos together into an upgrade binary.

Functional testing:

  • Follow the tests here for Equella with and without Kaltura: https://openequella.github.io/tests/migration/64QA3-to-OS/TestEnablingKaltura.html
    • Note: You’ll need to rebuild Equella with the Kaltura code included

Regression testing:

  • Start with Equella 6.4-QA3 (which has Kaltura enabled), upgrade to Equella without Kaltura, and then upgrade to Equella with Kaltura, following the guide here: https://openequella.github.io/tests/migration/64QA3-to-OS/TestEnablingKaltura.html

#54 ( Make Oracle DB driver optional )

Regression test flagged Oracle DB driver is no longer included by default. To run these tests, you’ll need a build of Equella with Oracle drivers included.

Regression testing:

  • Ensure all DB operations using Oracle work. These include: CRUD operations for items, DB migrations, taking DBs offline, adding secondary DBs / reporting DBs, running reports in BIRT and in Equella.

#44 / #46 ( Installer / Upgrader built via SBT )

Installers and upgraders are all built via SBT.

Regression testing:

  • TestLink: regression tests flagged
  • Run the installer on each supported operating system. Ensure you can launch Equella.
  • Upgrade Equella from a previous (commercial) release to this release.

#41 ( Remove eCommerce )

eCommerce was never used by clients in Equella (since it was an option when generating commercial licenses).

Regression testing:

  • Ensure there is no mention of eCommerce features in the collection definition editors, Settings page, Admin Console, or ACLs; and all associated database tables have been removed.

#33 ( Upgrade ROME )

Regression testing:

  • TestLink: regression tests flagged
  • Test RSS and ATOM feeds

#27 ( Work out what to do about hardcoded SHA256 hash salt )

Functional testing:

  • Set the equella.salt property to various values and test logging in with a password

Regression testing:

  • Ensure the default salt property is the original hardcoded salt by importing an existing institution and logging in

#5 ( Remove license validation components )

Functional testing: TestLink eqos-5340

  • Ensure Equella runs without asking for a license
  • Ensure no mention of licensing is in the Server Admin pages

Fixes arising from cherry pick


Regression testing:

  • Ensure Course and Activation REST endpoints are available and a simple request works on either.
  • Ensure the “self” link on an activation is correct.

Upgrade javax.servlet, flickr, datatools, sqlserver jdbc, kalturaclient


Regression testing: TestLink: Regression tests flagged

  • Ensure the following work (can be at a high level): Reporting, Flickr, Kaltura and SQL Server

Upgrade srw servlet


Regression testing: TestLink: Regression Tests flagged

  • There is a known issue with SRW - https://github.com/openequella/openEQUELLA/issues/115

Use latest jna


Regression testing: TestLink: Regression Tests flagged

  • Test inplace editor applet

Option to self-generate a keystore when building or use a previously


Regression testing:

  • Ensure you can use the existing keystore to sign jars

“Use a custom param for the course ID” in Canvas

  • Functional testing:
    • Canvas integration using activations in Equella. Ensure both the “course label” and “SIS ID” fields on the Canvas course are passed through to Equella (you will need to test one at a time since one overrides the other). When activating an attachment the course will already be selected.
  • Performance testing: N/A
  • Regression testing: N/A

EQ-31 ensure IMS/SCORM resources containing query strings will work

  • Functional testing: TBD
  • Performance testing: TBD
  • Regression testing: TBD

EQ-32 batched audit log removal

  • Functional testing: N/A
  • Performance testing: Generate a massive audit_log_entry table of old entries in 6.4 and run “delete audit logs” task. See how responsive the login for other users is (login auditing must be turned on). Do the same on 6.5.
  • Regression testing: Make sure it works :) (ie audit log table is cleared of old entries)

EQ-33 don’t use the public bookmark, use the actual params

  • Functional testing:
    • Ensure permissions are setup so users must login to see search page. Use Share functionality on a search page (try various filtering and advanced search options to generate a URL with many query string parameters). Copy the URL, logout of Equella and paste the URL into the browser -> User is forced to login before being directed to search page with all the parameters maintained.
  • Performance testing: N/A
  • Regression testing: N/A

EQ-34 use string URLs instead of URL URLs

  • Functional testing: TBD
  • Performance testing: TBD
  • Regression testing:
    • Access the file manager, and perform CRUD operations.


  • Functional testing:
    • On the Course REST endpoint, provide a “code” query string parameter and sure the relevant course is returned. e.g. /api/Course/?code=EQ101 (user must have LIST_COURSE_INFO privilege)
  • Performance testing: N/A
  • Regression testing: N/A

EQ-2038 course API refactor

Activation, Course,

  • Functional testing: N/A
  • Performance testing: N/A
  • Regression testing:
    • General Course and Activation REST endpoint testing (covered by “Fixes arising from cherry pick” already)

EQ-1045 (et al) refactors of entity rest services


  • Functional testing:
    • Pick an entity type (e.g. Collection) and test that error strings are being returned correctly on the REST endpoint. Errors to test are: 404 on a collection, 404 on a collection lock, attempt to edit a locked collection, edit security on a collection and leave the “who” field on a permission blank.
  • Performance testing: N/A
  • Regression testing: N/A

EQ-2026 Do some validation on entities. don’t let entity editing be a free-for-all

  • Functional testing:
    • Pick an entity type (e.g. Collection) and try to change its UUID via the REST API -> Should error
    • Create an entity and try to set the owner, createdDate and modifiedDate fields. -> Creation should succeed, but when retrieving the collection again it should not show the values for those fields that you passed in (they should be the actual owner, modified date etc)
    • Do the same again, but pass in a parameter ?import=true (note: you need to be logged in as TLE_ADMINISTRATOR to do this) -> Fields should be set to the values you passed in.
    • Edit/create a course via the REST API but leave the code field blank. -> Should receive a 400 response
  • Performance testing: N/A
  • Regression testing: TBD
  • Functional testing:
    • Add content to Canvas (from all available methods: push from Equella, navigation menu, resource selection, html editor button) and ensure the opened content opens up in a new browser tab

Users can edit the names of selected resources that will be added to the LMS in a selection session

  • Functional testing:
    • Edalex has already begun testing. Need to test with Blackboard, Canvas, Brightspace, Moodle. When adding content to the LMS (NOT via push from Equella method) the user is given the option to edit the names of the selected items and attachments that will appear in the LMS. For Moodle, the two main integration types should be tested (selectOrAdd and structured).

A new checkbox “Select all attachments” has been added to the “Add to External System” page.

  • Functional testing: TestLink eqos-1945
    • On the “add to external system” item page there is a new checkbox to select all of the attachments on the item for pushing. Any LMS will do as it’s just a client side script to check the boxes.
  • Functional testing:
    • Doesn’t matter about which LMS is selected, just make sure that clicking on the link to the LMS content appears in a new tab.

Course builder in brightspace not using selected module

  • Functional testing:
    • Using the course builder in Brightspace, select a module/folder other than the top one. When you launch the Equella tool, the folder list on the RHS should have the appropriate folder selected by default.

New permission for selection sessions

  • Functional testing: TestLink eqos-1942
    • Using an LMS (should probably try all of them…) try to add content into the LMS without the INTEGRATION_SELECTION_SESSION permission granted. (it’s actually granted by default when you upgrade to 6.5) -> should be presented with an error screen that does not include the Equella LHS menu.
    • Ensure that users with the permission can select and add Equella content into the LMS.
  • Regression testing:
    • After successfully adding content to the LMS, try to view the content in the LMS as a user that does not have the INTEGRATION_SELECTION_SESSION privilege (but does have relevant item viewing privs) -> Should succeed

URL checker number of attempts

TestLink eqos-1943 eqos-1944 URL checker will disable links to external sites (e.g. Link attachments) if the URL check fails 10 times, and will send email notifications to item owners if the check fails 5 times. This hard coded settings are now configurable in optional-config.properties

urlChecker.triesUntilWarning = 3
urlChecker.triesUntilDisabled = 5
  • Functional testing:
    • Set the values to a low number and run the URL checker task several times (scheduledtasksdebug.do page). Note that after each run you need to hack the database to set the last checked date of the URL (referenced_url table) to something old as otherwise it will refuse to re-check. -> Ensure links are disabled and notifications are sent after the relevant number of tries. Note that to send email notifications another task must be run to send the emails (CheckEmailsTask (?))

SQL Server concurrency issue

  • Functional testing:
    • Import institution containing referenced URLs (that don’t already exist) but occur multiple times in the imported items into an Equella using a SQL Server database. -> Should succeed and not throw an error about deadlocks or stale URL objects etc
  • Performance testing:
    • Unfortunately the only possible fix was to remove the concurrent import of 4 items at a time, so performance will be affected. An institution import is not exactly something the user will sit an watch, but it should not blow out to take several hours. (unless it was already doing so…)

The TLE_ADMINISTRATOR account is not required to accept DRM agreements

  • Functional testing:
    • When logged into Equella as TLE_ADMINISTRATOR the user should never see a DRM agreement page on DRM protected items.

Users were able to access inactive copyright attachments via using a direct URL

  • Functional testing:
    • Obtained a link to a copyright (e.g. CAL) protected attachment when it activated. Then delete that activation and paste in the link copied earlier into the browser -> should receive an error saying that the attachment is not activated.

The item moderation REST API would return a random workflow node status each time it was invoked

  • Functional testing:
    • Using an item in moderation, visit the REST moderation endpoint (/api/item/[uuid]/[version]/moderation) and click the browser refresh several times -> The returned content should stay the same and should be a valid representation of the item’s current moderation status.
  • Functional testing:
    • Visit a DRM protected item in Equella and ensure there are no links on the RHS to view the item history and other similar links.

Issues Covered in General Regression Test

  • #95 (Scrub equella-deps)
  • #83 (Upgrade commons-beanutils)
  • #67 ( Guice recipes library changes )
  • #61 ( SBT build loose ends )
  • #52 ( Hibernate classloading issues )
  • #51 ( Jafer z3950 / SRW library conflict )
  • #64 ( Remove image processing from conversion service ) - dead code removal
  • #37 ( Create a “learningedge-config” eclipse project and ant task for easier dev config setup )

Change the My tasks UI to allow for selection of multiple items, then allow moderators with the correct (new) permissions the ability to approve and reject tasks in bulk, and sequentially process tasks without returning to the results page between each task.

  • Functional testing: Testlink eqos-1898

Change the Manage tasks UI to allow for selection of multiple items, then allow admin users with the correct (new) permissions the ability to approve and reject tasks in bulk, and assign multiple tasks to a specific moderator.

  • Functional testing: Testlink eqos-1885->eqos-1894

Enhance the filtering and sorting capacity, and also make it easier for users to find the tasks they need to process by showing tasks assigned to them at the top, followed by tasks they could process then those assigned to others, also sorted in priority order.

  • Functional testing: Testlink eqos-1880->eqos-1881

Update both Manage tasks and My tasks pages to allow for complex filtering, including by assignment, collection, owner, date modified and assignee.

  • Functional testing: Testlink eqos-1882->eqos-1884

New bulk actions that can be performed against selected items including removing from workflow, moving from one workflow task to another and selecting live items not currenty in workflow and adding to a specific workflow task within the associated workflow.

  • Functional testing: Testlink eqos-1851, eqos-1852, eqos-1853, eqos-1871->1876

Add ability to configure workflow notifications per task, and allow users to opt in or out of workflow notificaitons.

  • Functional testing: Testlink eqos-1816->1834
  • Functional testing: Testlink eqos-1900, eqos-1901, eqos-1902, eqos-1903, eqos-1904, eqos-1905

Updated the Moderation page so that the Approve/Reject buttons appear in a more logical position, and the workflow comments can be easily viewed in a scrollable panel.

  • Functional testing: Testlink ?

A new workflow task type, ‘script task’, allows users to write a script which will automatically run as part of the workflow and proceed to the next workflow step.

  • Functional testing: Testlink eqos-1835->1850

Contributors now have the ability to drag an drop attachments directly into the wizard without opening the multi-step dialog.

  • Functional testing: Testlink “Contribution” area

Security fix changes

Deserialization of untrusted Java Objects

  • Functional testing: Try to create an app which takes advantage of ysoserial. Not easy to describe how to do this.

Server-side Request Forgery

  • Functional testing: This is the servlet that allows scripts to avoid cross site scripting. e.g. http://[equella]/p/geturl?url=someexternalurl It fetches content from the external site and serves it up as though it came from Equella. This is now turned OFF by default (you will get a 404 error if you attempt to go to http://[equella]/p/geturl ), and needs to be turned on in optional-config.properties -> httpProxyServlet.enabled=true

Open Redirect

  • Functional testing: Manipulate the URL in the logon.do page parameter. E.g. http://localhost:8065/workflow/logon.do?.page=//www.google.com
  • Regression tesing: Make sure that standard Equella URLs still work. E.g. logout of Equella and paste an Equella URL that requires login into the browser. Make sure that the user is redirected to the proper URL once logged in.

XML DTD Entity Injection - The web application parses externally supplied malicious XML Document Type Definitions (DTD), which can be used to read the contents of local files, determine the existence of files and folders on the system, and cause denial of service.

  • Functional testing: This was acheived by using an external DTD and engineered RSS feed in an RSS portlet. Difficult to reproduce without expert security testing knowledge.

Missing HTTP Strict Transport Security - Strict-Transport-Security is not used; this may allow an attacker to eavesdrop on or modify communication in transit.

  • Functional testing: Your whole Equella site needs to be covered by HTTPS, and you need to add the following to optional-config.properties -> strictTransportSecurity.maxage = {age in seconds}, where the age in seconds is typically something very very large. Once this setting is in place, all requests to the Equella server will be made as HTTPS.
  • Regression testing: I guess make sure that partial HTTPS Equellas (ie. Equella instances where only the login page is HTTPS) still work as expected when the strictTransportSecurity.maxage is removed from the optional-config file.