Review and codacy updates

Co-authored-by: Kory Draughn <[email protected]>

Author: d-w-moore

irods/test/login_auth_test.sh

@@ -46,16 +46,21 @@ fi
 update_json_file $LOCAL_ACCOUNT_ENV_FILE \
                  "$(newcontent $LOCAL_ACCOUNT_ENV_FILE ssl_keys encrypt_keys)"
 
-if [ "$server_hup" = y ]; then
+update_time=0
+# We won't time out, however we will warn for each minute the server
+# has not returned to readiness.
+if [ "$server_hup" = "y" ]; then
   # wait for server to be ready after configuration reload
   while true; do
     sleep 2
     if ils >/dev/null 2>&1; then
       break
     else
-      # Allow ~16 secs of total wait time.
-      [ $((++server_check)) -gt 8 ] && {
-        echo >&2 "Timed out on server reload"; exit 3; }
+      now=$(date +%s)
+      if [ $now -ge $((update_time + 60)) ]; then
+        echo >&2 "At [$(date)] ... still waiting on server reload";
+        update_time=$now
+      fi
     fi
   done
 fi

irods/test/scripts/test_support_functions

@@ -21,7 +21,7 @@ set_up_ssl() {
 }
 
 # Clears out environment and resets to rodsadmin 'rods'.
-# Meant mostly to allow initial steps by a rodsadminfor setting up tests.
+# Meant mostly to allow initial steps by a rodsadmin for setting up tests.
 
 iinit_as_rods() {
   rm -fr ~/.irods
@@ -119,7 +119,6 @@ _begin_pam_environment_and_password() {
     mkdir ~/.irods
     echo "$ENV" > ~/.irods/irods_environment.json
 
-    # TODO: check: it seems /dev/tty won't work if docker exec is not invoked with -t
     if [ -n "$1" -a -z "$SKIP_IINIT_FOR_PASSWORD" ]; then
         iinit <<<"$1" 2>/tmp/iinit_as_alice.log
     fi
@@ -206,7 +205,8 @@ setup_pyN() {
   fi
 }
 
-# requires image to descend from bats-python3
+# Call to both initialize and activate a virtualenv with the requested Python3 interpreter
+# installed.  Requires image to descend from 'bats-and-system-python'.
 activate_virtual_env_with_prc_installed()
 {
     local py_venv=${1:-pyN}
@@ -219,6 +219,8 @@ activate_virtual_env_with_prc_installed()
     python -c 'import irods' || { echo >&2 "ERROR: python-irodsclient install failed."; false; }
 }
 
+# Produces an output of a precise timestamp with the file content appended,
+# as an indicator of whether a file has been modified.
 mtime_and_content()
 {
     stat -c%y "$1"

test_harness/multiple_node/README.md

@@ -23,14 +23,14 @@ Currently the database server is fixed as Postgres.
 
 The file `.github/workflows/run-the-tests.yml` describes a Github action which
 will be started to run the client test suite in response to creating a pull
-request, or pushing new commits to the Github branch, containing it.
+request, or pushing new commits to the GitHub branch, containing it.
 
 The command-line recipe outlined in the file also supports running the
 test suite on any workstation with docker compose installed.
 
 A summary of how to run the tests "at the bench" follows:
 
-   1. Change the working directory to the repository top directory, e.g.:
+   1. Change the working directory to the root directory of the repository, e.g.:
       ```
       cd /path/to/python-irodsclient
       ```
@@ -39,8 +39,8 @@ A summary of how to run the tests "at the bench" follows:
       ```
       ./docker-testing/start_containers.sh 4.3.4 3.11
       ```
-      This builds and runs the docker images for the project,  with "4.3.4" being the iRODS
-      version installed on the provider and "3.11" is the version of python run on the client side.
+      This builds and runs the docker images for the project, with "4.3.4" being the iRODS
+      version installed on the provider and "3.11" being the version of python installed on the client side.
 
    3. Run:
       ```

test_harness/multiple_node/start_containers.sh

@@ -46,8 +46,6 @@ python_version=\"${PYTHON_VERSION}\"
 irods_version=\"${IRODS_VERSION}\"
 irods_major=\"${IRODS_MAJOR}\"" >.env
 
-# In case the docker-compose setup varies between iRODS major releases, the .YML file may be a symbolic link.
-
 docker compose -f harness-docker-compose-irods-${IRODS_MAJOR}.yml build $SHELL_DOCKER_COMPOSE_BUILD_ARGS
 
 if [ -z "$DO_NOT_RUN" ]; then

test_harness/multiple_node/stop_containers.sh

@@ -21,6 +21,4 @@ fi
 
 IRODS_MAJOR=${IRODS_VERSION//.*/}
 
-# In case the docker-compose setup varies between iRODS major releases, the .YML file may be a symbolic link.
-
 docker compose -f harness-docker-compose-irods-${IRODS_MAJOR}.yml down

test_harness/single_node/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-A series of docker images which support running isolated test scripts (using BATS, bash, or Python).
+A series of Docker images which support running isolated test scripts (using BATS, bash, or Python).
 Once built, the images allow loading and customizing the Docker container environment for a given 
 test script.
 
@@ -50,7 +50,7 @@ Sample command lines to build Docker images:
    Builds (ignoring docker cache) images based on specific iRODS package version and desired
    Python Interpreter version, optionally with a restricted list of Docker files in need of rebulding.
 
-### To run a test script.
+### To run a test script
 
 ```
 $REPO_ROOT/irods/test/harness/docker_container_driver.sh $REPO_ROOT/irods/test/scripts/run_local_suite

test_harness/single_node/install.sh

@@ -3,7 +3,6 @@
 # A script to manage the main steps in installing an iRODS server as well as all necessary support. (Dependencies,
 # catalog database, etc.)
 
-IRODS_HOME=/var/lib/irods
 DEV_HOME="$HOME"
 : ${DEV_REPOS:="$DEV_HOME/github"}
 
@@ -29,7 +28,7 @@ add_package_repo()
       sudo apt update
 }
 
-# Expand a spec of the leading version tuple eg. 4.3.4 out  to the full name of
+# Expand a spec of the leading version tuple eg. 4.3.4 out to the full name of
 # the most recent matching version of the package
 
 # Report the latest version spec (including OS) that matches the env var IRODS_PACKAGE_VERSION (eg. "5.0.2" -> "5.0.2-0~jammy)
@@ -50,8 +49,7 @@ while [[ "$1" = -* ]]; do
   ARG="$1"
   shift
   case $ARG in
-    --i=* | --irods=* |\
-    --irods-version=*) IRODS_PACKAGE_VERSION=${ARG#*=};;
+    --i=* | --irods=* | --irods-version=* ) IRODS_PACKAGE_VERSION=${ARG#*=};;
     --w=* | --with=* | --with-options=* ) withopts=${ARG#*=} ;;
   esac
 done

test_harness/single_node/irods_version_greater_or_equal_to

@@ -39,5 +39,5 @@ if __name__ == '__main__':
         j = json.load(open(version_files[0]))
         version_to_test = j["irods_version"]
 
-    if  version_to_tuple(version_to_test) < version_to_tuple(arg[0]):
+    if version_to_tuple(version_to_test) < version_to_tuple(arg[0]):
         exit(1)

test_harness/single_node/setup_python_rule_engine

@@ -4,8 +4,8 @@
 
 wait=""
 if [ $1 = --wait ]; then
-  wait=1
-  shift
+    wait=1
+    shift
 fi
 
 DIR=$(dirname "$0")
@@ -82,7 +82,7 @@ if [ -n "$wait" ]; then
     times=0
     OUTFILE=/tmp/irule_output.stderr
     while :; do
-        irule -a 2>/dev/null| grep irods_rule_engine_plugin-python-instance >/dev/null
+        irule -a 2>/dev/null | grep irods_rule_engine_plugin-python-instance >/dev/null
         [ ${PIPESTATUS[1]} -eq 0 ] && break
         sleep 1
         if [ $((++times)) -ge 10 ]; then

test_harness/utility/iinit.py

@@ -10,7 +10,6 @@
 import sys
 from os import chmod
 from os.path import expanduser,exists,join
-from getopt import getopt
 
 
 home_env_path = expanduser('~/.irods')