Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-5156

Please document MemoryTestCase

    Details

      Description

      lsst.utils.tests.MemoryTestCase is used extensively throughout our test suite, but it is lacking in documentation and it's not clear under what circumstances its use is required or encouraged. Please add appropriate documentation to the Software Unit Test Policy .

      See also this thread on clo.

        Attachments

          Issue Links

            Activity

            Hide
            tjenness Tim Jenness added a comment -

            I'm about to dive into documenting all the changes to testing that arrived in DM-5561 and it would be nice if we could decide what we are doing on this ticket before I start. The reason is that this ticket is adding some items which I will be immediately changing but other parts (such as coverage) might be fine to leave in. If people just want to merge this work I can start working from that. Either way, let me know.

            Show
            tjenness Tim Jenness added a comment - I'm about to dive into documenting all the changes to testing that arrived in DM-5561 and it would be nice if we could decide what we are doing on this ticket before I start. The reason is that this ticket is adding some items which I will be immediately changing but other parts (such as coverage) might be fine to leave in. If people just want to merge this work I can start working from that. Either way, let me know.
            Hide
            jsick Jonathan Sick added a comment -

            I’d be happy to mark this ticket as “invalid” because clearly I’m the wrong person to be assigned on this ticket and what I have probably isn’t useful.

            Show
            jsick Jonathan Sick added a comment - I’d be happy to mark this ticket as “invalid” because clearly I’m the wrong person to be assigned on this ticket and what I have probably isn’t useful.
            Hide
            swinbank John Swinbank added a comment -

            I think Jonathan's text is better than no text. I think Jonathan's text + a sentence or two lifted from K-T and Paul's comments above is really all we need. I'd be happy to write something, but it won't be done this side of the weekend.

            Given the timescale, maybe makes sense for Tim to go ahead and merge DM-5561, then feel free to assign this to me and I'll see if anything should be added on top of that when I get chance.

            Show
            swinbank John Swinbank added a comment - I think Jonathan's text is better than no text. I think Jonathan's text + a sentence or two lifted from K-T and Paul's comments above is really all we need. I'd be happy to write something, but it won't be done this side of the weekend. Given the timescale, maybe makes sense for Tim to go ahead and merge DM-5561 , then feel free to assign this to me and I'll see if anything should be added on top of that when I get chance.
            Hide
            tjenness Tim Jenness added a comment -

            I'm happy to merge and close this ticket and then subsume it into my rewrite of testing (e.g. removing the suite() items from the example added in this ticket). Partly depends on whether we are okay with these words being "gospel" whilst I'm working on DM-5973.

            Show
            tjenness Tim Jenness added a comment - I'm happy to merge and close this ticket and then subsume it into my rewrite of testing (e.g. removing the suite() items from the example added in this ticket). Partly depends on whether we are okay with these words being "gospel" whilst I'm working on DM-5973 .
            Hide
            jsick Jonathan Sick added a comment -

            Okay, I’ve shipped it. I’ve added text saying that MemoryTestCase should be the last suite, and that we should always be using it. I’ve haven’t captured Paul’s note on why objects need to be deleted. I think Tim Jenness should be able to handle this now with a more sweeping refresh of the unit testing docs.

            Show
            jsick Jonathan Sick added a comment - Okay, I’ve shipped it. I’ve added text saying that MemoryTestCase should be the last suite, and that we should always be using it. I’ve haven’t captured Paul’s note on why objects need to be deleted. I think Tim Jenness should be able to handle this now with a more sweeping refresh of the unit testing docs.

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                swinbank John Swinbank
                Reviewers:
                John Swinbank
                Watchers:
                John Parejko, John Swinbank, Jonathan Sick, Kian-Tat Lim, Paul Price, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel