rda-python-dscheck 2.0.7__py3-none-any.whl → 3.0.0__py3-none-any.whl

rda_python_dscheck/PgCheck.py

@@ -211,7 +211,7 @@ def check_dscheck_options(cact, aname):
       "Miss check index per Info option -CI(-CheckIndex)",
       "Need Machine Hostname per -HN for new daemon control",
       "Need Application command name per -CM for new daemon control",
-      "Must be {} to process Checks in daemon mode".format(PgLOG.PGLOG['GDEXUSER']),
+      "Must be {} to process Checks in daemon mode".format(PgLOG.PGLOG['COMMONUSER']),
       "Miss Command information per Info option -CM(-Command)",
    ]
    erridx = -1
@@ -223,7 +223,7 @@ def check_dscheck_options(cact, aname):
    if 'DM' in PgOPT.params:
       if cact != "PC":
          erridx = 0
-      elif PgLOG.PGLOG['CURUID'] != PgLOG.PGLOG['GDEXUSER']:
+      elif PgLOG.PGLOG['CURUID'] != PgLOG.PGLOG['COMMONUSER']:
          erridx = 5
       elif 'CI' in PgOPT.params:
          erridx = 1
@@ -280,7 +280,7 @@ def check_dscheck_options(cact, aname):
       wtime = PgOPT.params['WI'] if 'WI' in PgOPT.params else 30
       logon = PgOPT.params['LO'] if 'LO' in PgOPT.params else 1
       PgSIG.start_none_daemon(aname, cact, PgOPT.params['LN'], 1, wtime, logon)
-      if not ('CI' in PgOPT.params or 'DS' in PgOPT.params or PgOPT.params['LN'] == PgLOG.PGLOG['GDEXUSER']):
+      if not ('CI' in PgOPT.params or 'DS' in PgOPT.params or PgOPT.params['LN'] == PgLOG.PGLOG['COMMONUSER']):
          PgOPT.set_default_value("SN", PgOPT.params['LN'])
 
    # minimal wait interval in seconds for next check
@@ -581,7 +581,7 @@ def start_one_dscheck(pgrec, logact = 0):
 
    lidx = get_process_host(limits, pgrec['hostname'], pgrec['command'], pgrec['action'], logact)
    if lidx < 0 or skip_dscheck_record(pgrec, host, logact): return 0
-   cmd = "pgstart_{} ".format(specialist) if PgLOG.PGLOG['CURUID'] == PgLOG.PGLOG['GDEXUSER'] else ""
+   cmd = "pgstart_{} ".format(specialist) if PgLOG.PGLOG['CURUID'] == PgLOG.PGLOG['COMMONUSER'] else ""
    if not PgUtil.pgcmp(host, PgLOG.PGLOG['PBSNAME'], 1):
       if reach_dataset_limit(pgrec): return 0
       cmd += get_specialist_shell(specialist) + 'qsub '
@@ -1532,7 +1532,7 @@ def validate_daemons():
          if not pgrec:
             PgOPT.action_error("Daemon Control Index '{}' is not in RDADB".format(val))
          elif(PgOPT.OPTS[PgOPT.PGOPT['CACT']][2] > 0 and PgOPT.params['LN'] != pgrec['specialist'] and
-              PgLOG.PGLOG['CURUID'] != PgLOG.PGLOG['GDEXUSER']):
+              PgLOG.PGLOG['CURUID'] != PgLOG.PGLOG['COMMONUSER']):
             PgOPT.action_error("{}: must be {}, owner of Daemon Control Index {}".format(PgOPT.params['LN'], pgrec['specialist'], val))
    else: # found none-equal condition sign
       pgrec = PgDBI.pgmget("dsdaemon", "DISTINCT dindex",
@@ -1573,7 +1573,7 @@ def validate_checks():
             if not pgrec:
                PgOPT.action_error("Check Index '{}' is not in RDADB".format(val))
             elif(PgOPT.OPTS[PgOPT.PGOPT['CACT']][2] > 0 and PgOPT.params['LN'] != pgrec['specialist'] and
-                 PgLOG.PGLOG['CURUID'] != PgLOG.PGLOG['GDEXUSER']):
+                 PgLOG.PGLOG['CURUID'] != PgLOG.PGLOG['COMMONUSER']):
                PgOPT.action_error("{}: must be {}, owner of Check Index {}".format(PgOPT.params['LN'], pgrec['specialist'], val))
       else: # found none-equal condition sign
          pgrec = PgDBI.pgmget("dscheck", "cindex", PgDBI.get_field_condition("cindex", PgOPT.params['CI'], 0, 1), PgOPT.PGOPT['extlog'])

rda_python_dscheck/__init__.py

@@ -1 +1,27 @@
+"""rda_python_dscheck: dataset check (dscheck) utility package.
 
+This package exposes two parallel APIs:
+
+1. Legacy module-based API (back-compat). Import the capitalized
+   submodule and call its module-level functions, e.g.::
+
+       from rda_python_dscheck import PgCheck
+
+2. Class-based API (preferred for new code). Import the class from the
+   lower-case module and either instantiate or subclass it, e.g.::
+
+       from rda_python_dscheck.pg_check import PgCheck
+
+The legacy submodule is eagerly imported below so that
+``from rda_python_dscheck import PgCheck`` continues to return the module
+object that existing callers expect.
+"""
+
+from . import PgCheck
+
+__version__ = "2.0.8"
+
+__all__ = [
+   "PgCheck",
+   "__version__",
+]

rda_python_dscheck/ds_check.py

@@ -279,7 +279,7 @@ def set_daemon_info():
          if pgrec:
             modcnt += PgDBI.pgupdt(tname, record, cnd, PgOPT.PGOPT['extlog'])
          else:
-            if 'specialist' not in record and PgOPT.params['LN'] != PgLOG.PGLOG['GDEXUSER']: record['specialist'] = PgOPT.params['LN']
+            if 'specialist' not in record and PgOPT.params['LN'] != PgLOG.PGLOG['COMMONUSER']: record['specialist'] = PgOPT.params['LN']
             didx = PgDBI.pgadd(tname, record, PgOPT.PGOPT['extlog']|PgLOG.AUTOID)
             if didx:
                PgLOG.pglog("Daemon Control Index {} added".format(didx), PgOPT.PGOPT['wrnlog'])
@@ -506,12 +506,12 @@ def process_dschecks():
 
    logact = PgLOG.LOGERR
 
-   if PgLOG.PGLOG['CURUID'] == PgLOG.PGLOG['GDEXUSER'] and (time.time()%(3*PgSIG.PGSIG['CTIME'])) < 60:
+   if PgLOG.PGLOG['CURUID'] == PgLOG.PGLOG['COMMONUSER'] and (time.time()%(3*PgSIG.PGSIG['CTIME'])) < 60:
       logact |= PgLOG.EMEROL
 
    cnd = PgOPT.get_hash_condition("dscheck", "ST", None, 1)
    if cnd: cnd += " AND "
-   if 'SN' not in PgOPT.params and PgOPT.params['LN'] != PgLOG.PGLOG['GDEXUSER']:
+   if 'SN' not in PgOPT.params and PgOPT.params['LN'] != PgLOG.PGLOG['COMMONUSER']:
        cnd += "specialist = '{}' AND ".format(PgOPT.params['LN'])
 
    if 'WR' in PgOPT.params: PgCheck.start_dsrqsts(cnd, logact)
@@ -530,12 +530,12 @@ def process_dscheck_options():
 
    logact = PgLOG.LOGERR
 
-   if PgLOG.PGLOG['CURUID'] == PgLOG.PGLOG['GDEXUSER'] and (time.time()%(3*PgSIG.PGSIG['CTIME'])) < 60:
+   if PgLOG.PGLOG['CURUID'] == PgLOG.PGLOG['COMMONUSER'] and (time.time()%(3*PgSIG.PGSIG['CTIME'])) < 60:
       logact |= PgLOG.EMEROL
 
    cnd = PgOPT.get_hash_condition("dscheck", "ST", None, 1)
    if cnd: cnd += " AND "
-   if 'SN' not in PgOPT.params and PgOPT.params['LN'] != PgLOG.PGLOG['GDEXUSER']:
+   if 'SN' not in PgOPT.params and PgOPT.params['LN'] != PgLOG.PGLOG['COMMONUSER']:
        cnd += "specialist = '{}' AND ".format(PgOPT.params['LN'])
 
    acnd = PgOPT.get_hash_condition("dscheck", None, "ST", 1)
@@ -654,7 +654,7 @@ def check_host_connection():
       hostname = pgrecs['hostname'][i]
       cmd = "ssh {} ps".format(hostname)
       if specialist != PgLOG.PGLOG['CURUID']:
-         if PgLOG.PGLOG['CURUID'] != PgLOG.PGLOG['GDEXUSER']:
+         if PgLOG.PGLOG['CURUID'] != PgLOG.PGLOG['COMMONUSER']:
             PgLOG.pglog("{}: Cannot check connection to '{}' for {}".format(PgLOG.PGLOG['CURUID'], hostname, specialist), PgLOG.LOGERR)
             continue
          else:

rda_python_dscheck/dscheck.py

@@ -225,7 +225,7 @@ class DsCheck(PgCheck):
             if pgrec:
                modcnt += self.pgupdt(tname, record, cnd, self.PGOPT['extlog'])
             else:
-               if 'specialist' not in record and self.params['LN'] != self.PGLOG['GDEXUSER']: record['specialist'] = self.params['LN']
+               if 'specialist' not in record and self.params['LN'] != self.PGLOG['COMMONUSER']: record['specialist'] = self.params['LN']
                didx = self.pgadd(tname, record, self.PGOPT['extlog']|self.AUTOID)
                if didx:
                   self.pglog("Daemon Control Index {} added".format(didx), self.PGOPT['wrnlog'])
@@ -411,11 +411,11 @@ class DsCheck(PgCheck):
    # process the checks
    def process_dschecks(self):
       logact = self.LOGERR
-      if self.PGLOG['CURUID'] == self.PGLOG['GDEXUSER'] and (time.time()%(3*self.PGSIG['CTIME'])) < 60:
+      if self.PGLOG['CURUID'] == self.PGLOG['COMMONUSER'] and (time.time()%(3*self.PGSIG['CTIME'])) < 60:
          logact |= self.EMEROL
       cnd = self.get_hash_condition("dscheck", "ST", None, 1)
       if cnd: cnd += " AND "
-      if 'SN' not in self.params and self.params['LN'] != self.PGLOG['GDEXUSER']:
+      if 'SN' not in self.params and self.params['LN'] != self.PGLOG['COMMONUSER']:
           cnd += "specialist = '{}' AND ".format(self.params['LN'])
       if 'WR' in self.params: self.start_dsrqsts(cnd, logact)
       if 'WU' in self.params: self.start_dsupdts(cnd, logact)
@@ -427,11 +427,11 @@ class DsCheck(PgCheck):
    # process the checks
    def process_dscheck_options(self):
       logact = self.LOGERR
-      if self.PGLOG['CURUID'] == self.PGLOG['GDEXUSER'] and (time.time()%(3*self.PGSIG['CTIME'])) < 60:
+      if self.PGLOG['CURUID'] == self.PGLOG['COMMONUSER'] and (time.time()%(3*self.PGSIG['CTIME'])) < 60:
          logact |= self.EMEROL
       cnd = self.get_hash_condition("dscheck", "ST", None, 1)
       if cnd: cnd += " AND "
-      if 'SN' not in self.params and self.params['LN'] != self.PGLOG['GDEXUSER']:
+      if 'SN' not in self.params and self.params['LN'] != self.PGLOG['COMMONUSER']:
           cnd += "specialist = '{}' AND ".format(self.params['LN'])
       acnd = self.get_hash_condition("dscheck", None, "ST", 1)
       if acnd: acnd += " AND "
@@ -513,7 +513,7 @@ class DsCheck(PgCheck):
          hostname = pgrecs['hostname'][i]
          cmd = "ssh {} ps".format(hostname)
          if specialist != self.PGLOG['CURUID']:
-            if self.PGLOG['CURUID'] != self.PGLOG['GDEXUSER']:
+            if self.PGLOG['CURUID'] != self.PGLOG['COMMONUSER']:
                self.pglog("{}: Cannot check connection to '{}' for {}".format(self.PGLOG['CURUID'], hostname, specialist), self.LOGERR)
                continue
             else:

rda_python_dscheck/dscheck.usg

@@ -9,18 +9,30 @@ well as any specialist-defined command.
 
 The mental model has three layers:
 
-  1. A check record  - a row in GDEXDB that captures one deferred command:
-                       its name, arguments, owner, working directory, target
-                       host, retry policy, and current status.
-  2. A daemon control - a row in GDEXDB that tells the centralized 'dscheck'
-                        daemon how many concurrent processes of a given
-                        command a given specialist may run on a given host,
-                        and at what host priority.
-  3. The dscheck daemon - a long-running process that wakes on a fixed
-                          interval, adds due 'dsupdt'/'dsrqst' check records,
-                          and starts (or restarts) commands from check
-                          records on hosts chosen according to daemon
-                          control configuration.
+  A check record         - a row in GDEXDB that captures one deferred command:
+                           its name, arguments, owner, working directory,
+                           target host, retry policy, and current status.
+  daemon/crontab control - a row in GDEXDB that tells the centralized
+                           'dscheck' driver (whether running as a long-lived
+                           daemon or as a short-lived crontab invocation) how
+                           many concurrent processes of a given command a
+                           given specialist may run on a given host, and at
+                           what host priority.
+  The dscheck driver     - a process that wakes on a fixed interval, adds
+                           due 'dsupdt'/'dsrqst' check records, and starts
+                           (or restarts) commands from check records on
+                           hosts chosen according to daemon control
+                           configuration. The driver may run either as a
+                           long-running daemon ('-PC -DM start') or as a
+                           short-lived crontab invocation ('-PC' every
+                           minute via cron). It may run as the specialist's
+                           own loginname, or as PGLOG['COMMONUSER'] (default
+                           'gdexdata'). When it runs as COMMONUSER it also
+                           submits PBS jobs (via qsub) on behalf of every
+                           specialist whose loginname belongs to the same
+                           group as COMMONUSER and who has a properly
+                           installed pgstart_<loginname> binary (see the
+                           rda_python_setuid README, '-p|--pgstart').
 
 Typical lifecycle of a deferred command:
 
@@ -80,7 +92,7 @@ into an action.
 Notation:
   []       - the enclosed element is optional.
   (A|B)    - either A or B may be used (a short form and a long form).
-  -OPT     - an option name. Names are case-insensitive; values are not.
+  -<OPT>   - OPT is an option name. Names are case-insensitive; values are not.
 
 Every dscheck invocation has at most one Action option, which selects the
 task to perform. Mode options change how the chosen action behaves. Info
@@ -95,26 +107,34 @@ are accepted, and aliases are noted with each option.
 2.1 Quick Start
 
   Show the full document, paged through 'more':
-    dscheck
+  dscheck
 
   Show the description of a single option:
-    dscheck -h -AC
-    dscheck -AC -h
+  dscheck -h -AC
 
   List your own daemon control records:
-    dscheck -GD
+
+  dscheck -GD
 
   List your own active check records:
-    dscheck -GC
+
+  dscheck -GC
 
   Add a deferred run of a script on PBS:
-    dscheck -AC -CM myscript.sh -HN PBS
+
+  dscheck -AC -CM myscript.sh -HN PBS
 
   Email yourself the status of all your active checks:
-    dscheck -EC
 
-  Start the dscheck daemon (typical for the operator):
-    dscheck -PC -DM start
+  dscheck -EC
+
+  Start the dscheck driver as a long-running daemon (typical for the operator):
+
+  dscheck -PC -DM start
+
+  Or run the dscheck driver from crontab every minute (lightweight alternative):
+
+  * * * * * dscheck -PC
 
 2.2 Filters and Special Characters in Queries
 
@@ -135,20 +155,9 @@ Every option except -IF (-InputFile) may be supplied either on the command
 line or in an input file. -IF is itself only valid on the command line.
 A single dscheck invocation may combine command-line options with one or
 more input files. If the only options are inside a single input file, the
--IF prefix may be omitted:
-
-  dscheck mycheck.in
-
-See the description of -IF in Section 5.2 for the input-file format
-(comments, action/mode markers, single-value assignments, and tabular
-multi-value assignments, including delimiter overrides).
-
-2.4 Getting Help
-
-  dscheck                         # full document, displayed via 'more'
-  dscheck -(h|help)               # full document
-  dscheck [Option] -(h|help)      # description of [Option]
-  dscheck -(h|help) [Option]      # same as above
+-IF prefix may be omitted. See the description of -IF in Section 5.2 for
+the input-file format (comments, action/mode markers, single-value assignments,
+and tabular multi-value assignments, including delimiter overrides).
 
 A printable copy of this document is the file dscheck.usg installed under
 the python package rda_python_dscheck.
@@ -224,16 +233,6 @@ Delete Daemon Control - remove daemon control records by index.
     CM = ALL    - apply to any command not otherwise configured for this
                   specialist.
 
-  Example - configure schuster on PBS for any command, with up to 4
-  concurrent checks at priority 1 (lower number = higher priority), driven
-  from input file daemon.ctl:
-
-    dscheck -SD -ND -IF daemon.ctl
-
-  <<Content of input file daemon.ctl>>
-  DaemonIndex<:>Specialist<:>Command<:>Hostname<:>ProcessLimit<:>Priority<:>
-  0<:>schuster<:>ALL<:>PBS<:>4<:>1<:>
-
 
 3.1.2 Get Daemon Control
   -GD or -GetDaemon, retrieves daemon control records. With no Info-option
@@ -364,7 +363,7 @@ Unlock Check - clear leftover lock information after an abnormal exit.
 
   Add the executable 'test3' for deferred execution on PBS:
 
-    dscheck -AC -CM test3 -HN PBS
+  dscheck -AC -CM test3 -HN PBS
 
   The command 'test3' must be executable from the working directory on
   the PBS machine.
@@ -461,7 +460,13 @@ Unlock Check - clear leftover lock information after an abnormal exit.
 
 3.3 Check Process Actions
 
-The dscheck daemon starts and restarts deferred commands automatically.
+The dscheck driver starts and restarts deferred commands automatically.
+It can run either as a long-running daemon ('-PC -DM start'), or as a
+short-lived crontab invocation ('-PC' run every minute by cron). The
+driver may run as the specialist's own loginname, or as
+PGLOG['COMMONUSER'] (default 'gdexdata'); when run as COMMONUSER it
+also submits PBS jobs on behalf of every specialist in COMMONUSER's
+group that has a properly installed pgstart_<loginname> binary.
 Operators (and, in non-daemon mode, specialists) can also drive command
 execution from the command line, interrupt running commands, and email
 status summaries.
@@ -504,11 +509,28 @@ Available actions:
     -DM stop, -DM logon, and -DM logoff stop the daemon, enable detailed
     logging, and disable detailed logging respectively.
 
-  Non-daemon mode:
-    Without -DM, dscheck processes the current set of check records once.
-    -WU and -WR must be set explicitly if you want due 'dsupdt'/'dsrqst'
-    work to be added before processing. -CI restricts processing to
-    specific check indices.
+  Crontab mode (cron-driven, no -DM):
+    The same -PC action can be driven from cron instead of running as a
+    long-lived daemon. A typical setup is to run it every minute:
+      * * * * * dscheck -PC
+    Each invocation performs one cycle (add due 'dsupdt'/'dsrqst' work,
+    then start/restart checks) and exits. -WI is ignored because the
+    cron schedule controls the cadence.
+
+  Non-daemon (one-shot) mode:
+    Without -DM and not driven by cron, dscheck processes the current
+    set of check records once. -WU and -WR must be set explicitly if you
+    want due 'dsupdt'/'dsrqst' work to be added before processing. -CI
+    restricts processing to specific check indices.
+
+  Running user (daemon or crontab mode):
+    The driver may run as the specialist's own loginname (handling only
+    that specialist's checks), or as PGLOG['COMMONUSER'] (default
+    'gdexdata'). When run as COMMONUSER, it also submits PBS jobs (via
+    qsub) on behalf of every specialist whose loginname is in the same
+    group as COMMONUSER and who has a properly installed
+    pgstart_<loginname> binary (see rda_python_setuid, option
+    '-p|--pgstart').
 
 3.3.2 Interrupt Check
   -IC or -InterruptCheck, stops a running command and recursively kills
@@ -571,6 +593,7 @@ Available actions:
          [-(MO|Modules)  ModuleList]
          [-(EV|Environments)  EnvironmentPairList]
          [-(QS|QsubOptions)  PBSBatchOptions]
+         [-(SH|SSHHostname) RemoteHostname]
          [-(DB|Debug) DebugModeInfo]
 
 
@@ -665,11 +688,17 @@ multiple values is an error.
   -ON or -OrderNames, a string of single-letter field codes that
   controls the sort order of -GC (-GetCheck) output.
 
+  -SH or -SSHHostname, used with -SO (-SetOptions): remote host name on
+  which the dynamic-option command should run. When supplied, the command
+  is invoked via 'ssh <hostname> ...' instead of locally. Defaults to
+  running locally when omitted.
+
   -AO or -ActOption, the token that marks Action and Mode options in
   input files. Defaults to '<!>'.
 
   -WI or -WaitInterval, the time the dscheck daemon sleeps between
-  cycles. Defaults to 120 seconds (2 minutes).
+  cycles. Defaults to 120 seconds (2 minutes). Ignored when -PC is
+  driven from cron, since the cron schedule controls the cadence.
 
 5.2 Multi-Value Info Options
 

rda_python_dscheck/pg_check.py

@@ -62,6 +62,7 @@ class PgCheck(PgOPT, PgCMD):
          'MT': [1, 'MaxrunTime',     0],
          'OF': [1, 'OutputFile',     0],
          'ON': [1, 'OrderNames',     0],
+         'SH': [1, 'SSHHostname',    0],
          'AO': [1, 'ActOption',      1],  # default to <!>
          'WI': [1, 'WaitInterval',   1],
          'AN': [2, 'ActionName',     0],
@@ -189,7 +190,7 @@ class PgCheck(PgOPT, PgCMD):
          "Miss check index per Info option -CI(-CheckIndex)",
          "Need Machine Hostname per -HN for new daemon control",
          "Need Application command name per -CM for new daemon control",
-         "Must be {} to process Checks in daemon mode".format(self.PGLOG['GDEXUSER']),
+         "Must be {} to process Checks in daemon mode".format(self.PGLOG['COMMONUSER']),
          "Miss Command information per Info option -CM(-Command)",
       ]
       erridx = -1
@@ -199,7 +200,7 @@ class PgCheck(PgOPT, PgCMD):
       if 'DM' in self.params:
          if cact != "PC":
             erridx = 0
-         elif self.PGLOG['CURUID'] != self.PGLOG['GDEXUSER']:
+         elif self.PGLOG['CURUID'] != self.PGLOG['COMMONUSER']:
             erridx = 5
          elif 'CI' in self.params:
             erridx = 1
@@ -253,7 +254,7 @@ class PgCheck(PgOPT, PgCMD):
          wtime = self.params['WI'] if 'WI' in self.params else 30
          logon = self.params['LO'] if 'LO' in self.params else 1
          self.start_none_daemon(aname, cact, self.params['LN'], 1, wtime, logon)
-         if not ('CI' in self.params or 'DS' in self.params or self.params['LN'] == self.PGLOG['GDEXUSER']):
+         if not ('CI' in self.params or 'DS' in self.params or self.params['LN'] == self.PGLOG['COMMONUSER']):
             self.set_default_value("SN", self.params['LN'])
       # minimal wait interval in seconds for next check
       self.PGOPT['minlimit'] = self.params['WI'] = self.PGSIG['WTIME']
@@ -492,7 +493,7 @@ class PgCheck(PgOPT, PgCMD):
          return 0
       lidx = self.get_process_host(limits, pgrec['hostname'], pgrec['command'], pgrec['action'], logact)
       if lidx < 0 or self.skip_dscheck_record(pgrec, host, logact): return 0
-      cmd = "pgstart_{} ".format(specialist) if self.PGLOG['CURUID'] == self.PGLOG['GDEXUSER'] else ""
+      cmd = "pgstart_{} ".format(specialist) if self.PGLOG['CURUID'] == self.PGLOG['COMMONUSER'] else ""
       if not self.pgcmp(host, self.PGLOG['PBSNAME'], 1):
          if self.reach_dataset_limit(pgrec): return 0
          cmd += self.get_specialist_shell(specialist) + 'qsub '
@@ -680,7 +681,8 @@ class PgCheck(PgOPT, PgCMD):
       if not pgrec or options != pgrec[optname]: return options
       record = {}
       errmsg = ''
-      record[optname] = options = self.get_dynamic_options(options[1:], pgcheck['oindex'], pgcheck['otype'])
+      sshhost = self.params.get('SH')
+      record[optname] = options = self.get_dynamic_options(options[1:], pgcheck['oindex'], pgcheck['otype'], sshhost)
       if not options and self.PGLOG['SYSERR']:
          record['status'] = pgcheck['status'] = 'E'
          record['pid'] = 0
@@ -1272,7 +1274,7 @@ class PgCheck(PgOPT, PgCMD):
             if not pgrec:
                self.action_error("Daemon Control Index '{}' is not in RDADB".format(val))
             elif(self.OPTS[self.PGOPT['CACT']][2] > 0 and self.params['LN'] != pgrec['specialist'] and
-                 self.PGLOG['CURUID'] != self.PGLOG['GDEXUSER']):
+                 self.PGLOG['CURUID'] != self.PGLOG['COMMONUSER']):
                self.action_error("{}: must be {}, owner of Daemon Control Index {}".format(self.params['LN'], pgrec['specialist'], val))
       else: # found none-equal condition sign
          pgrec = self.pgmget("dsdaemon", "DISTINCT dindex",
@@ -1308,7 +1310,7 @@ class PgCheck(PgOPT, PgCMD):
                if not pgrec:
                   self.action_error("Check Index '{}' is not in RDADB".format(val))
                elif(self.OPTS[self.PGOPT['CACT']][2] > 0 and self.params['LN'] != pgrec['specialist'] and
-                    self.PGLOG['CURUID'] != self.PGLOG['GDEXUSER']):
+                    self.PGLOG['CURUID'] != self.PGLOG['COMMONUSER']):
                   self.action_error("{}: must be {}, owner of Check Index {}".format(self.params['LN'], pgrec['specialist'], val))
          else: # found none-equal condition sign
             pgrec = self.pgmget("dscheck", "cindex", self.get_field_condition("cindex", self.params['CI'], 0, 1), self.PGOPT['extlog'])

rda_python_dscheck-3.0.0.dist-info/METADATA

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: rda_python_dscheck
+Version: 3.0.0
+Summary: RDA python package to add and process batch jobs
+Author-email: Zaihua Ji <zji@ucar.edu>
+Project-URL: Homepage, https://github.com/NCAR/rda-python-dscheck
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rda_python_common
+Requires-Dist: rda_python_setuid
+Dynamic: license-file
+
+# dscheck
+
+Python project to add and process batch jobs for the
+[NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
+
+The user guide for this utility tool can be viewed at:
+[User guide](https://gdex-docs-dscheck.readthedocs.io).
+
+## Source layout
+
+The package lives under `src/rda_python_dscheck/`.  The three files most
+relevant to setup and customization are:
+
+- **`dscheck.py`** — entry point installed as the `dscheck` console script.
+  Defines the `DsCheck` class which subclasses `PgCheck`, parses command-line
+  options via `self.parsing_input`, and dispatches to the appropriate action
+  handler (`add_check_info`, `process_check`, `get_check_info`,
+  `set_dscheck_options`, ...).  Build new actions by adding a method here and
+  routing to it from `start_actions()`.
+
+- **`pg_check.py`** — defines the `PgCheck` class (inherits from `PgCMD` in
+  `rda_python_common`).  Holds the master `OPTS` option table, the `ALIAS`
+  map for long/alias names, the `TBLHASH` table field maps for `dscheck` and
+  `dsdaemon`, and the helper methods shared by every action (option
+  validation, dynamic batch-option resolution, daemon control,
+  host/specialist resolution, etc.).  Add or change options here, then
+  document them in `dscheck.usg`.
+
+- **`dscheck.usg`** — single source of truth for the user-facing documentation
+  displayed by `dscheck -?` and rendered as the
+  [user guide](https://gdex-docs-dscheck.readthedocs.io).  Section 3 lists
+  Action options, Section 4 lists Mode options, and Section 5 lists Single-
+  and Multi-Value Info options.  When you add a new option to `OPTS` in
+  `pg_check.py`, add a matching entry to the appropriate subsection of this
+  file and (if relevant) to the per-action usage block in Section 3.
+
+## Environment setup
+
+Create a Python environment first; package installs in the next section run
+inside whichever environment you activate here.
+
+### Option A — Python venv (DECS machines)
+
+```bash
+python3 -m venv $ENVHOME          # e.g. /glade/u/home/gdexdata/gdexmsenv
+source $ENVHOME/bin/activate
+```
+
+### Option B — Conda (DAV/Casper)
+
+```bash
+conda create --prefix $ENVHOME python=3.12   # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
+conda activate $ENVHOME
+```
+
+## Dependencies
+
+In addition to `rda_python_common`, this package depends on
+`rda_python_setuid`.  When `dscheck` runs as the common user, the
+`start_one_dscheck()` method in `pg_check.py` submits each PBS batch job via a
+`pgstart_<specialist>` wrapper, and those per-specialist `pgstart_*` wrappers
+are provisioned by `rda_python_setuid`.  Both dependencies are declared in
+`pyproject.toml` and are pulled in automatically on install.
+
+## Installing rda-python-dscheck
+
+Pick whichever install mode fits your workflow.  All variants pull in the
+transitive dependencies (`rda_python_common` and `rda_python_setuid`)
+automatically.
+
+For local development, clone this repo alongside your project and install it
+in editable mode so that changes are picked up without re-installing:
+
+```bash
+git clone https://github.com/NCAR/rda-python-dscheck.git
+cd rda-python-dscheck
+pip install -e .
+```
+
+To test a specific branch (e.g. an in-progress feature or fix branch), pass
+`-b/--branch` to `git clone`:
+
+```bash
+git clone -b <branch-name> https://github.com/NCAR/rda-python-dscheck.git
+cd rda-python-dscheck
+pip install -e .
+```
+
+For a regular (non-editable) install from a checkout:
+
+```bash
+pip install /path/to/rda-python-dscheck
+```
+
+For a production install on a system that uses the published distribution:
+
+```bash
+pip install rda_python_dscheck
+```
+
+To upgrade an existing install to the latest published release:
+
+```bash
+pip install --upgrade rda_python_dscheck
+```
+
+## Setuid Setup
+
+Unlike `dsarch`, `dscheck` is **not** wired as a `setuid_dscheck` link.  It
+relies instead on the `pgstart_*` setuid binaries provided by
+`rda_python_setuid` (pulled in automatically as a dependency):
+
+- In cron, `dscheck` itself is run as the common user `PGLOG['COMMONUSER']`
+  (default `gdexdata`) via `pgstart_<COMMONUSER> dscheck` (e.g.
+  `pgstart_gdexdata dscheck`).
+- While running as the common user, `start_one_dscheck()` in `pg_check.py`
+  submits each PBS batch job as the owning specialist via
+  `pgstart_<specialist> ... qsub ...`, so each job runs under that specialist's
+  identity.
+
+This means setup is about installing the `pgstart_*` binaries, not creating a
+`dscheck -> pywrapper` symlink.
+
+> **Note:** The setuid actions in this section are optional.  If
+> `rda_python_setuid` is already installed and fully set up in your
+> environment, you can skip this section.
+
+### Install the pgstart binaries (requires sudo access to each user)
+
+Run these steps once per environment:
+
+```bash
+# 1. Compile the pywrapper C binary (once per environment):
+pywrapper-install -c|--compile -n|--username gdexdata
+
+# 2. Install pgstart_<COMMONUSER> so cron can run 'pgstart_gdexdata dscheck':
+pywrapper-install -p|--pgstart -n|--username gdexdata
+
+# 3. Install a pgstart_<specialist> binary for each specialist whose jobs
+#    dscheck submits.  Run either by PGLOG['ADMINUSER'] (default zji, if it
+#    has 'sudo -u <specialist>'), or by <specialist> directly:
+pywrapper-install -p|--pgstart -n|--username <specialist>
+```
+
+`pywrapper-install` with no arguments displays the full user guide.
+
+### Update an existing installation (no sudo required)
+
+When the package is upgraded and a new `pywrapper.c` is bundled, recompile and
+reinstall all `pgstart_*` binaries using the existing ones:
+
+```bash
+pywrapper-install -u|--update
+```
+
+## Documentation sync
+
+The user guide rendered at
+[gdex-docs-dscheck.readthedocs.io](https://gdex-docs-dscheck.readthedocs.io) is
+generated from `src/rda_python_dscheck/dscheck.usg` in this repository.  When a
+pull request that modifies `dscheck.usg` is merged here, an automated workflow
+converts the updated `dscheck.usg` into the RST-format source files in the
+[gdex-docs-dscheck](https://github.com/NCAR/gdex-docs-dscheck) repository and
+opens a pull request there with the regenerated docs, ready for review and
+merge.  No manual RST editing is required — keep all user-facing content in
+`dscheck.usg` and let the sync produce the docs.

rda_python_dscheck-3.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+rda_python_dscheck/PgCheck.py,sha256=c936Q7UwatjxjtVDXYrprs61gZW6-LncXMoKWSXf4RY,64229
+rda_python_dscheck/__init__.py,sha256=4Wtgj9ephcxz20cPTI4SZ_XCuCM0oqtfq9wL8kcVr3Y,734
+rda_python_dscheck/ds_check.py,sha256=9Zjoz12STauUmtucjLJHBzRoCZzqfLrsZk0FKYxTwcM,24315
+rda_python_dscheck/dscheck.py,sha256=XxVtSQZLmfWCjeVPRQK7PCYCOPBdWOVu6InxfYGJadE,24817
+rda_python_dscheck/dscheck.usg,sha256=IpbGbcCdhpNUgrMEKzRSWqX3n_vO6G8SUre3wYl4cQ4,34076
+rda_python_dscheck/pg_check.py,sha256=ecxl1tt0KN72gxDa5mseV_sOiQ_jcclxdtSDF1X-QzE,67488
+rda_python_dscheck-3.0.0.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
+rda_python_dscheck-3.0.0.dist-info/METADATA,sha256=itqH1vqBCI8YSnn0RbiUSYGAutFDqV14-D3OydzprvU,6798
+rda_python_dscheck-3.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+rda_python_dscheck-3.0.0.dist-info/entry_points.txt,sha256=frVByX3Vp_Pd_zq93SXfItr5OMTd5tKeZzu5pbVXiGA,60
+rda_python_dscheck-3.0.0.dist-info/top_level.txt,sha256=NrvWqcHMRlQZJb0w85JrDlSXTp9DF-pDRQaAEABzFts,19
+rda_python_dscheck-3.0.0.dist-info/RECORD,,

rda_python_dscheck-2.0.7.dist-info/METADATA

@@ -1,22 +0,0 @@
-Metadata-Version: 2.4
-Name: rda_python_dscheck
-Version: 2.0.7
-Summary: RDA python package to add and process batch jobs
-Author-email: Zaihua Ji <zji@ucar.edu>
-Project-URL: Homepage, https://github.com/NCAR/rda-python-dscheck
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 5 - Production/Stable
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: rda_python_common
-Dynamic: license-file
-
-# dscheck
-
-Python project to add and process batch jobs for the [NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
-
-The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dscheck.readthedocs.io).
-

rda_python_dscheck-2.0.7.dist-info/RECORD

@@ -1,12 +0,0 @@
-rda_python_dscheck/PgCheck.py,sha256=lvh0XSWJID9J9fjqmDtpq6xW2ULC-bChAxAkm8MFzbk,64217
-rda_python_dscheck/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-rda_python_dscheck/ds_check.py,sha256=-js5Ex1k7V8ziE_k-ld5Z0l44QGYhvQtdYri9vsqNJA,24303
-rda_python_dscheck/dscheck.py,sha256=-vv7gw4xYIa1xofWo-o3972dDnR_FQZxZz6_S_kCCuk,24805
-rda_python_dscheck/dscheck.usg,sha256=upCHGwRcjrLoue4Z9nE3pMDZ3s09Qq1ujEH2eJhb2cg,32036
-rda_python_dscheck/pg_check.py,sha256=Riv1nJYocSKLDsOIIYmOmkKlWZLKDrA1uPpbUEYo1uo,67388
-rda_python_dscheck-2.0.7.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
-rda_python_dscheck-2.0.7.dist-info/METADATA,sha256=ezkK1sDQXrTcaTtHRlemEpeBOBQDmCOcHFLwuJainQk,812
-rda_python_dscheck-2.0.7.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-rda_python_dscheck-2.0.7.dist-info/entry_points.txt,sha256=frVByX3Vp_Pd_zq93SXfItr5OMTd5tKeZzu5pbVXiGA,60
-rda_python_dscheck-2.0.7.dist-info/top_level.txt,sha256=NrvWqcHMRlQZJb0w85JrDlSXTp9DF-pDRQaAEABzFts,19
-rda_python_dscheck-2.0.7.dist-info/RECORD,,