Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix ENGINX data cache search on IDAaaS #38027

Open
wants to merge 3 commits into
base: release-next
Choose a base branch
from

Conversation

GuiMacielPereira
Copy link
Contributor

@GuiMacielPereira GuiMacielPereira commented Sep 19, 2024

Description of work

From the issue described in #37398, the ENGINX files were still not being found in the data cache because part of the path was still using ENGIN-X instead of ENGINX.

Summary of work

I changed a few lines of code that ensure that when the shortname of the instrument is used (ENGINX) to find the index file, the path is also constructed consistently with this, and uses the shortname version.

Access ENGINX files easily on IDAaaS from the data cache.
Fixes #37398 .

Further detail of work

To test:

Test with build number 892.
Load ENGINX files on IDAaaS with the debug log enabled and check that the data cache is used.


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

This change makes sure that the path is built relative to the json
index file that was opened. Before, the short name might have been
used but the path was being constructed with the long name nonetheless.
This fix fixes access to ENGINX files on the data cache.
@GuiMacielPereira GuiMacielPereira added Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS labels Sep 19, 2024
@GuiMacielPereira GuiMacielPereira added this to the Release 6.11 milestone Sep 19, 2024
@sf1919 sf1919 linked an issue Sep 19, 2024 that may be closed by this pull request
The path separator on windows is different from the one on linux,
so I changed the output path to match the default separator of the OS
using make_preferred() and changed unit tests to check this path.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix search for ENGIN-X files in the instrument data cache
2 participants