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

Please get rid of "char" and "octet" data types

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ts_middleware
    • Labels:
      None
    • Story Points:
      2
    • Epic Link:
    • Sprint:
      TSSW Sprint - Jul 05 - Jul 19, TSSW Sprint - Jul 19 - Aug 02, TSSW Sprint - Aug 02 - Aug 16
    • Team:
      Telescope and Site
    • Urgent?:
      No

      Description

      ts_sal includes support for two data types (at least) that we aren't using and don't appear to be necessary:

      • char: this is an alias for "string" and is very confusing to me because it sounds like a single 8-bit int (the C definition) instead of a string. It is not used (except in Test).
      • octet: it's not being used (except in Test). Do we need it?

      I think all the remaining types I know about are used and are fairly self-explanatory.

      Would it be practical to remove support for either or both of these? Clearly it is not a high priority and it will be slightly disruptive because it will require minor changes to Test XML and unit tests in ts_sal and ts_salobj (which I am happy to do).

      Also: does ts_sal support "unsigned long long" and if not, would that be easy to add? It would be useful for long bitmasks. It's not a big deal because "long long" works, but unsigned is a more natural choice for bitmasks.

        Attachments

          Issue Links

          is blocked by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-31017 Update Test XML and salobj to stop using octet and char data types.

          • Done
          is cloned by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. CAP-745 Please get rid of "char" and "octet" data types

          • Undefined - No priority assigned (may not apply or be unknown)
          • Done

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            rowen Russell Owen created issue -
            dmills Dave Mills made changes -
            Field Original Value New Value
            Epic Link DM-27708 [ 442112 ]
            Story Points 2
            dmills Dave Mills made changes -
            Link This issue is cloned by DM-29854 [ DM-29854 ]
            dmills Dave Mills made changes -
            Sprint TSSW Sprint - Jul 5 - Jul 19 [ 1106 ]
            rowen Russell Owen made changes -
            Link This issue is blocked by DM-31017 [ DM-31017 ]
            wvreeven Wouter van Reeven made changes -
            Sprint TSSW Sprint - Jul 05 - Jul 19 [ 1106 ] TSSW Sprint - Jul 05 - Jul 19, TSSW Sprint - Jul 19 - Aug 02 [ 1106, 1108 ]
            dmills Dave Mills made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            Hide
            Permalink
            dmills Dave Mills added a comment -

            char and octet have been removed as vaild types in the XML.
            Note that "octet" is the IDL equivalent of "byte or unsigned 8-bit"
            so it will still appear in the IDL.

            Show
            dmills Dave Mills added a comment - char and octet have been removed as vaild types in the XML. Note that "octet" is the IDL equivalent of "byte or unsigned 8-bit" so it will still appear in the IDL.
            dmills Dave Mills made changes -
            Attachment Test_Telemetry.xml.char [ 51401 ]
            dmills Dave Mills made changes -
            Attachment Test_Telemetry.xml.octet [ 51402 ]
            Hide
            Permalink
            dmills Dave Mills added a comment -

            Tested using attached XML's

            rfactory@localhost:~/lsst/test$ salgenerator Test validate
            SAL_WORK_DIR=/home/rfactory/lsst/test6.11.1
            argv = Test validate
            SAL generator - 6.0.0
            checking Test
            checking validate
            XMLVERSION = 9.1.1
            Processing Test
            Add Generic Commands and Events
            Translating Test_scalars
            ****************************************************************
            ****************************************************************
            ERROR - Missing or invalid IDL_Type in Test_scalars:
            octet0
            ****************************************************************
            ****************************************************************

            SAL_WORK_DIR=/home/rfactory/lsst/test6.11.1
            argv = Test validate
            SAL generator - 6.0.0
            checking Test
            checking validate
            XMLVERSION = 9.1.1
            Processing Test
            Add Generic Commands and Events
            Translating Test_scalars
            ****************************************************************
            ****************************************************************
            ERROR - Missing or invalid IDL_Type in Test_scalars:
            char0
            ****************************************************************
            ****************************************************************

            Show
            dmills Dave Mills added a comment - Tested using attached XML's rfactory@localhost:~/lsst/test$ salgenerator Test validate SAL_WORK_DIR=/home/rfactory/lsst/test6.11.1 argv = Test validate SAL generator - 6.0.0 checking Test checking validate XMLVERSION = 9.1.1 Processing Test Add Generic Commands and Events Translating Test_scalars **************************************************************** **************************************************************** ERROR - Missing or invalid IDL_Type in Test_scalars: octet0 **************************************************************** **************************************************************** SAL_WORK_DIR=/home/rfactory/lsst/test6.11.1 argv = Test validate SAL generator - 6.0.0 checking Test checking validate XMLVERSION = 9.1.1 Processing Test Add Generic Commands and Events Translating Test_scalars **************************************************************** **************************************************************** ERROR - Missing or invalid IDL_Type in Test_scalars: char0 **************************************************************** ****************************************************************
            wvreeven Wouter van Reeven made changes -
            Sprint TSSW Sprint - Jul 05 - Jul 19, TSSW Sprint - Jul 19 - Aug 02 [ 1106, 1108 ] TSSW Sprint - Jul 05 - Jul 19, TSSW Sprint - Jul 19 - Aug 02, TSSW Sprint - Aug 02 - Aug 16 [ 1106, 1108, 1111 ]
            Hide
            Permalink
            dmills Dave Mills added a comment -

            Removed in latest SAL 6 updates. See test outputs here.

            Show
            dmills Dave Mills added a comment - Removed in latest SAL 6 updates. See test outputs here.
            dmills Dave Mills made changes -
            Reviewers Rob Bovill [ rbovill ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            Hide
            Permalink
            rbovill Rob Bovill added a comment -

            The char and octet data-types have been removed.  XML will need to be updated accordingly or tests will break.

            Show
            rbovill Rob Bovill added a comment - The char and octet data-types have been removed.  XML will need to be updated accordingly or tests will break.
            rbovill Rob Bovill made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            rbovill Rob Bovill made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            Hide
            Permalink
            rowen Russell Owen added a comment -

            I think it will suffice to release ts_xml 9.2 before we release this change in ts_sal.

            The only use of char and octet that I know of in ts_xml 9.1 is in the Test SAL component. I removed those fields July 9, in DM-31017.

            Show
            rowen Russell Owen added a comment - I think it will suffice to release ts_xml 9.2 before we release this change in ts_sal. The only use of char and octet that I know of in ts_xml 9.1 is in the Test SAL component. I removed those fields July 9, in DM-31017 .

              People

              Assignee:
              dmills Dave Mills
              Reporter:
              rowen Russell Owen
              Reviewers:
              Rob Bovill
              Watchers:
              Dave Mills, Rob Bovill, Russell Owen, Tiago Ribeiro, Wouter van Reeven
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.