Update help message (#357)

* Update help message Update help text for add_sus and subtract_sus to be more specific * Update parsers.py * Update account_logic.py Added error message if unlock run without sudo privilege --------- Co-authored-by: Nickolas Comeau <[email protected]>
pitt-crc · Mar 5, 2024 · c9bc8ea · c9bc8ea
1 parent 9f6e333
commit c9bc8ea
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/bank/account_logic.py b/bank/account_logic.py
@@ -21,6 +21,7 @@
 from .exceptions import *
 from .orm import Account, Allocation, DBConnection, Investment, Proposal
 from .system import EmailTemplate, Slurm, SlurmAccount
+from os import geteuid
 
 Numeric = Union[int, float]
 LOG = getLogger('bank.account_services')
@@ -1095,10 +1096,13 @@ def unlock(self, clusters: Optional[Collection[str]] = None, all_clusters=False)
         """Unlock the account on the given clusters
 
         Args:
-            clusters: Name of the clusters to unlock the account on. Defaults to all clusters.
+            clusters: Name of the clusters to unlock the account on. Defaults to all clusters. Must have sudo privileges to execute.
             all_clusters: Lock the user on all clusters
         """
 
+        if geteuid() != 0:
+           exit("ERROR: `unlock` must be run with sudo privileges!")
+
         self._set_account_lock(False, clusters, all_clusters)
 
 

diff --git a/bank/cli/parsers.py b/bank/cli/parsers.py
@@ -252,11 +252,11 @@ def _add_cluster_args(parser: ArgumentParser) -> None:
         """
 
         su_argument = dict(metavar='su', type=NonNegativeInt, default=0)
-        parser.add_argument('--all-clusters', **su_argument, help='service units awarded across all clusters')
+        parser.add_argument('--all-clusters', **su_argument, help='service units awarded/added/subtracted from all-clusters allocation, depending on invoked proposal operation')
 
         # Add per-cluster arguments for setting service units
         for cluster in settings.clusters:
-            parser.add_argument(f'--{cluster}', **su_argument, help=f'service units awarded on the {cluster} cluster')
+            parser.add_argument(f'--{cluster}', **su_argument, help=f'service units awarded/added/subtracted on the {cluster} cluster, depending on invoked proposal operation')
 
 
 class InvestmentParser(BaseParser):