review suggestions mon 10/7 - final review imminent

Author: d-w-moore

irods/test/scripts/test002.bats

@@ -1,4 +1,7 @@
 #!/usr/bin/env bats
+#
+# Test creation of .irodsA for iRODS native authentication using the free function,
+#    irods.client_init.write_pam_credentials_to_secrets_file
 
 . "$BATS_TEST_DIRNAME"/test_support_functions
 PYTHON=python3
@@ -7,12 +10,12 @@ PYTHON=python3
 # Run as ubuntu user with sudo; python_irodsclient must be installed (in either ~/.local or a virtualenv)
 #
 
-PASSWD=test123
+OLD_PAM_PASSWD="test123"
 NEW_PAM_PASSWD="new_pass"
 
 setup()
 {
-    setup_pam_login_for_alice $PASSWD
+    setup_pam_login_for_alice "$OLD_PAM_PASSWD"
 }
 
 teardown()
@@ -23,11 +26,11 @@ teardown()
 
 @test create_secrets_file {
 
+    # Old .irodsA is already created, so we delete it and alter the pam password.
     sudo chpasswd <<<"alice:$NEW_PAM_PASSWD"
     rm -f ~/.irods/.irodsA
     $PYTHON -c "import irods.client_init; irods.client_init.write_pam_credentials_to_secrets_file('$NEW_PAM_PASSWD')"
 
-
     # Define the core Python to be run, basically a minimal code block ensuring that we can authenticate to iRODS
     # without an exception being raised.
 

irods/test/scripts/test003.bats

@@ -1,4 +1,7 @@
 #!/usr/bin/env bats
+#
+# Test creation of .irodsA for iRODS pam_password authentication using the free function,
+#    irods.client_init.write_native_credentials_to_secrets_file
 
 . "$BATS_TEST_DIRNAME"/test_support_functions
 PYTHON=python3
@@ -7,30 +10,19 @@ PYTHON=python3
 # Run as ubuntu user with sudo; python_irodsclient must be installed (in either ~/.local or a virtualenv)
 #
 
-setup()
-{
- :
-}
-
-teardown()
-{
- :
-}
-
 @test create_irods_secrets_file {
 
     rm -fr ~/.irods
     mkdir ~/.irods
     cat > ~/.irods/irods_environment.json <<-EOF
 	{ "irods_host":"$(hostname)",
-          "irods_port":1247,
-          "irods_user_name":"rods",
-          "irods_zone_name":"tempZone"
-        }
+      "irods_port":1247,
+      "irods_user_name":"rods",
+      "irods_zone_name":"tempZone"
+    }
 	EOF
     $PYTHON -c "import irods.client_init; irods.client_init.write_native_credentials_to_secrets_file('rods')"
 
-
     # Define the core Python to be run, basically a minimal code block ensuring that we can authenticate to iRODS
     # without an exception being raised.
 
@@ -42,5 +34,5 @@ print ('env_auth_scheme=%s' % ses.pool.account._original_authentication_scheme)
 "
     OUTPUT=$($PYTHON -c "$SCRIPT")
     # Assert passing value
-    [ $OUTPUT = env_auth_scheme=native ]
+    [ $OUTPUT = "env_auth_scheme=native" ]
 }

irods/test/scripts/test012.bats

@@ -1,4 +1,7 @@
 #!/usr/bin/env bats
+#
+# Test creation of .irodsA for iRODS pam_password authentication, this time purely internal to the PRC
+# library code.
 
 . "$BATS_TEST_DIRNAME"/test_support_functions
 PYTHON=python3
@@ -64,5 +67,5 @@ $SCRIPT")
     [ "$SECRETS_0" = "$SECRETS_1" ]
 
     # Test assertion: authentication method is pam_password
-    [[ $OUTPUT = *=pam_password ]]
+    [ $OUTPUT = "env_auth_scheme=pam_password" ]
 }