Add comments and minor fixups

1 files changed, 27 insertions, 2 deletions

diff --git a/selenium_eduvpn.py b/selenium_eduvpn.py
index 4c16d80..65c5104 100644
--- a/selenium_eduvpn.py
+++ b/selenium_eduvpn.py
@@ -4,10 +4,14 @@ from selenium import webdriver
 from selenium.webdriver.common.keys import Keys
 from pyvirtualdisplay import Display
 
+
+# Logs in to the default vpn user portal with selenium
 def login_oauth(driver, authURL):
+    # Go to the oauth url and verify the title
     driver.get(authURL)
     assert "VPN Portal - Sign In" in driver.title
 
+    # Get credentials
     portal_user = os.getenv("PORTAL_USER")
     if portal_user is None:
         print("Error: No portal username set, set the PORTAL_USER env var")
@@ -18,25 +22,46 @@ def login_oauth(driver, authURL):
         print("Error: No portal password set, set the PORTAL_PASS env var")
         sys.exit(1)
 
+    # Fill in username
     elem = driver.find_element_by_name("userName")
     elem.clear()
     elem.send_keys(portal_user)
 
+    # Fill in password
     elem = driver.find_element_by_name("userPass")
     elem.clear()
     elem.send_keys(portal_pass)
-    driver.find_element_by_css_selector('.frm > fieldset:nth-child(2) > button:nth-child(2)').click()
+
+    # Click login button
+    driver.find_element_by_css_selector(
+        ".frm > fieldset:nth-child(2) > button:nth-child(2)"
+    ).click()
+
+    # Check that we have reached the approve application page
     assert "VPN Portal - Approve Application" in driver.title
-    driver.find_element_by_css_selector('.frm > fieldset:nth-child(1) > button:nth-child(1)').click()
+    # Click approve
+    driver.find_element_by_css_selector(
+        ".frm > fieldset:nth-child(1) > button:nth-child(1)"
+    ).click()
+
 
 if __name__ == "__main__":
+    # Invalid arguments
     if len(sys.argv) != 2:
         print("Error: no auth url specified")
         sys.exit(1)
+
+    # Start a virtual display using xvfb
     disp = Display()
     disp.start()
+
+    # Use the firefox driver
     driver = webdriver.Firefox()
+
+    # Login to the portal
     authURL = sys.argv[1]
     login_oauth(driver, authURL)
+
+    # Cleanup
     driver.close()
     disp.stop()