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

Make ScriptQueue automatically find standard and external script directories

    XMLWordPrintable

    Details

      Description

      Enhance ScriptQueue to find the standard and external script directories if those constructor arguments are None, make None the default, and make the command line arguments optional.

      The default values will be given by environment variables TS_STANDARDSSCRIPTS_DIR and TS_EXTERNALSCRIPTS_DIR. If one uses eups then these will be automatically defined. For deployment one must either explicitly define these or provide the information on the command line.

        Attachments

          Activity

          Hide
          rowen Russell Owen added a comment - - edited

          I also added a new ScriptQueue event rootDirectories to publish where the script queue is looking for scripts.

          ts_xml pull request: https://github.com/lsst-ts/ts_xml/pull/81
          ts_scriptqueue pull request: https://github.com/lsst-ts/ts_scriptqueue/pull/24

          Show
          rowen Russell Owen added a comment - - edited I also added a new ScriptQueue event rootDirectories to publish where the script queue is looking for scripts. ts_xml pull request: https://github.com/lsst-ts/ts_xml/pull/81 ts_scriptqueue pull request: https://github.com/lsst-ts/ts_scriptqueue/pull/24
          Hide
          ttsai Te-Wei Tsai added a comment -

          The new features were added and the related unit tests were done. Good job!

          Show
          ttsai Te-Wei Tsai added a comment - The new features were added and the related unit tests were done. Good job!
          Hide
          rowen Russell Owen added a comment - - edited

          Te-Wei Tsai had a few comments which I paraphrase here (with permission), along with my responses

          • I feel the analyzer of EFD may not understand the column names "standard" and "external". They are a little vague to me.
            • The argument 'arg' of the ScriptQueue._get_scripts_path method is not clear (at least without the doc string). In addition, if you say it is optional, but it must be set.
            • The name delete_script_pkg_env_vars() in nopytest_script_queue.py is a unclear; consider something like delete_script_pkg_default_env_vars().

          My responses:
          • "standard" and "external" EFD column names: I hope these will be clear in the context of the table name "rootDirectory", and they have <Description> fields.
          • _get_scripts_path: you raise a good point. Documenting the argument as (optional) is incorrect. I fixed that and enhanced the documentation. I agree that "arg" is too vague a name for the script directory argument. I changed it to "patharg".
          • delete_script_pkg_env_vars. I see your point but I feel the name is accurate and I worry that adding "default" to the name may make people wonder about non-default environment variables, whatever those might be. I did enhance the documentation to make it clearer why these variables were being deleted. I hope that will suffice.

          Thank you for the thoughtful review.

          Show
          rowen Russell Owen added a comment - - edited Te-Wei Tsai had a few comments which I paraphrase here (with permission), along with my responses I feel the analyzer of EFD may not understand the column names "standard" and "external". They are a little vague to me. • The argument 'arg' of the ScriptQueue._get_scripts_path method is not clear (at least without the doc string). In addition, if you say it is optional, but it must be set. • The name delete_script_pkg_env_vars() in nopytest_script_queue.py is a unclear; consider something like delete_script_pkg_default_env_vars(). My responses: • "standard" and "external" EFD column names: I hope these will be clear in the context of the table name "rootDirectory", and they have <Description> fields. • _get_scripts_path: you raise a good point. Documenting the argument as (optional) is incorrect. I fixed that and enhanced the documentation. I agree that "arg" is too vague a name for the script directory argument. I changed it to "patharg". • delete_script_pkg_env_vars. I see your point but I feel the name is accurate and I worry that adding "default" to the name may make people wonder about non-default environment variables, whatever those might be. I did enhance the documentation to make it clearer why these variables were being deleted. I hope that will suffice. Thank you for the thoughtful review.
          Hide
          rowen Russell Owen added a comment -

          Merged ts_scriptqueue and ts_xml to develop

          Merged ts_scriptqueue develop to master and tagged as v1.4.0
          New documentation served: http://staff.washington.edu/rowen/ts_scriptqueue/index.html

          Show
          rowen Russell Owen added a comment - Merged ts_scriptqueue and ts_xml to develop Merged ts_scriptqueue develop to master and tagged as v1.4.0 New documentation served: http://staff.washington.edu/rowen/ts_scriptqueue/index.html

            People

            Assignee:
            rowen Russell Owen
            Reporter:
            rowen Russell Owen
            Reviewers:
            Te-Wei Tsai
            Watchers:
            Russell Owen, Te-Wei Tsai
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.