Prevent running Catalog algorithms if not logged in

[Jay Rainey]

If a user executes a catalog algorithm there is no logic to inform them if they are not logged in. Instead (currently), the algorithm outputs the default output direction, which is empty.

Instead, functionality needs to be implemented to throw a runtime if the user is not logged in, and placed in the following catalog classes:

• CatalogDownloadDataFiles.cpp
• CatalogGetDataFiles.cpp
• CatalogGetDataSets.cpp
• CatalogKeepAlive.cpp
• CatalogListInstruments.cpp
• CatalogListInvestigationTypes.cpp
• CatalogLogout.cpp
• CatalogMyDataSearch.cpp
• CatalogPublish.cpp
• CatalogSearch.cpp

To see this issue in action, run the following in Python:

from mantid.simpleapi import *

# Assuming you have previously logged into the catalog.
datasets = CatalogGetDataSets(InvestigationId = '1193002')
  
# If logged in, it would return 2, otherwise 0, rather than an error!
print str(len(datasets))

# Verify that we have any datafiles in the returned workspace.
print "The number of datasets for this investigation is: " + str(len(datasets))

[Jay Rainey]

Add method to check if used is logged in to catalog. Refs #9594.

Changeset: 3a5a62449186ac499c486dc7b660229586cda9ab

[Jay Rainey]

Call method before executing Catalog algorithms. Refs #9594.

Changeset: f6fd0a6204899981a5eaf979189f42dc9291d2bc

[Jay Rainey]

Revert previous two commit changes. Refs #9594.

Changeset: c3fe4ff26e194c2d759a3ae445113771c501a2cd

[Jay Rainey]

Add check to CatalogManager instead. Refs #9594.

• This removes the dependency of all catalog algorithms on CatalogAlgorithmHelper.

Changeset: 0f2bad7859eb41f2a38cf5d9d171df05d1412dfe

[Jay Rainey]

Forgot to remove CatalogManager from helper. Refs #9594.

Changeset: bcb975833c51034a1f21077eaf86d2e5a40bb490

[Jay Rainey]

To test

1. Run the script from the description BEFORE testing the ticket. Observe that datasets is 0, even though we are not logged into the catalog. This is incorrect!
2. Run the script AFTER, and observe that an error is thrown to inform the user that they are not logged into the catalog. You will need to add CatalogLogin(YOURUSERNAME,YOURPASSWORD to the start of the script.
3. Verify that the logic has been added to the top of each Catalog algorithm noted in the description.
4. Perform a ​code review.
5. Run through the catalog interface to verify it still works as expected.

[Keith Brown]

Merge remote-tracking branch 'origin/feature/9594_catalog_check_if_logged_in'

Full changeset: ​994c9c66a51f1e5822c42bc50813f2eb0fe45959

[Stuart Campbell]

This ticket has been transferred to github issue ​10437