Add comments to regression tests

23 files changed, 231 insertions, 5 deletions

diff --git a/tests/scripts/autologin-logout.script b/tests/scripts/autologin-logout.script
index f976a448..65d41367 100644
--- a/tests/scripts/autologin-logout.script
+++ b/tests/scripts/autologin-logout.script
@@ -1,21 +1,38 @@
+#
+# Check logging out after autologin returns to greeter and doesn't autologin again
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Autologin session starts
 SESSION START USER=alice
 XSERVER :.* ACCEPT-CONNECT
 SESSION CONNECT-XSERVER
+
+# Logout
 SESSION LOGOUT
+
+# X server resets
 XSERVER :.* DISCONNECT-CLIENTS
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
 # Wait in case the greeter tries to log in immediately
 *WAIT
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/autologin.script b/tests/scripts/autologin.script
index 53afcacd..7e93061d 100644
--- a/tests/scripts/autologin.script
+++ b/tests/scripts/autologin.script
@@ -1,10 +1,20 @@
+#
+# Check automaitcally logs in default user
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Default session starts
 SESSION START USER=alice
 XSERVER :.* ACCEPT-CONNECT
 SESSION CONNECT-XSERVER
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (SESSION TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/greeter-xserver-crash.script b/tests/scripts/greeter-xserver-crash.script
index 53afcacd..181dedc0 100644
--- a/tests/scripts/greeter-xserver-crash.script
+++ b/tests/scripts/greeter-xserver-crash.script
@@ -1,10 +1,20 @@
+#
+# Check X server crashing while running greeter is handled
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# ... FIXME
 SESSION START USER=alice
 XSERVER :.* ACCEPT-CONNECT
 SESSION CONNECT-XSERVER
+
+# ... FIXME
 *STOP-DAEMON
 # Don't know what order they will terminate
 (SESSION TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/headless.script b/tests/scripts/headless.script
index a3ded403..e25c7faa 100644
--- a/tests/scripts/headless.script
+++ b/tests/scripts/headless.script
@@ -1,4 +1,12 @@
+#
+# Check can run in headless mode
+#
+
 RUNNER DAEMON-START
+
+# No indication that anything is happening...
 *WAIT
+
+# Cleanup
 *STOP-DAEMON
 RUNNER DAEMON-EXIT STATUS=0
diff --git a/tests/scripts/login-gobject-guest-disabled.script b/tests/scripts/login-gobject-guest-disabled.script
index f46f0c12..0a23c118 100644
--- a/tests/scripts/login-gobject-guest-disabled.script
+++ b/tests/scripts/login-gobject-guest-disabled.script
@@ -1,14 +1,26 @@
+#
+# Check can't login to guest if account disabled
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login as guest
 GREETER LOGIN-GUEST
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=FALSE
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-guest-fail-setup-script.script b/tests/scripts/login-gobject-guest-fail-setup-script.script
index f46f0c12..9a75a855 100644
--- a/tests/scripts/login-gobject-guest-fail-setup-script.script
+++ b/tests/scripts/login-gobject-guest-fail-setup-script.script
@@ -1,14 +1,26 @@
+#
+# Check guest account fails gracefully if setup script fails
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login as guest
 GREETER LOGIN-GUEST
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=FALSE
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-guest-no-config.script b/tests/scripts/login-gobject-guest-no-config.script
index f46f0c12..a1c6fc19 100644
--- a/tests/scripts/login-gobject-guest-no-config.script
+++ b/tests/scripts/login-gobject-guest-no-config.script
@@ -1,14 +1,26 @@
+#
+# Check guest account is disabled by default
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login as guest
 GREETER LOGIN-GUEST
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=FALSE
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-guest-no-setup-script.script b/tests/scripts/login-gobject-guest-no-setup-script.script
index f46f0c12..3d86725e 100644
--- a/tests/scripts/login-gobject-guest-no-setup-script.script
+++ b/tests/scripts/login-gobject-guest-no-setup-script.script
@@ -1,14 +1,26 @@
+#
+# Check guest account fails gracefully if no setup script
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login as guest
 GREETER LOGIN-GUEST
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=FALSE
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-guest.script b/tests/scripts/login-gobject-guest.script
index aa86ea78..4f20161c 100644
--- a/tests/scripts/login-gobject-guest.script
+++ b/tests/scripts/login-gobject-guest.script
@@ -1,18 +1,32 @@
+#
+# Check can login as guest (not prompted for password)
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login as guest
 GREETER LOGIN-GUEST
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=TRUE
+
+# Greeter quits, session starts
 GREETER QUIT
 SESSION START USER=guest
 XSERVER :.* ACCEPT-CONNECT
 SESSION CONNECT-XSERVER
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (SESSION TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-invalid-user.script b/tests/scripts/login-gobject-invalid-user.script
index 65a23e5d..a61aeafc 100644
--- a/tests/scripts/login-gobject-invalid-user.script
+++ b/tests/scripts/login-gobject-invalid-user.script
@@ -1,16 +1,28 @@
+#
+# Check can't login with invalid user (but still prompted for password)
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login as invalid user
 GREETER LOGIN USERNAME=notauser
 GREETER SHOW-PROMPT TEXT="Password:"
 GREETER RESPOND TEXT="password"
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=FALSE
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-logout.script b/tests/scripts/login-gobject-logout.script
index 2461802d..0178660a 100644
--- a/tests/scripts/login-gobject-logout.script
+++ b/tests/scripts/login-gobject-logout.script
@@ -1,29 +1,49 @@
+#
+# Check logging out returns to the greeter
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Log in
 GREETER LOGIN USERNAME=alice
 GREETER SHOW-PROMPT TEXT="Password:"
 GREETER RESPOND TEXT="password"
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=TRUE
+
+# Greeter quits, session starts
 GREETER QUIT
 SESSION START USER=alice
 XSERVER :.* ACCEPT-CONNECT
 SESSION CONNECT-XSERVER
+
+# Logout of session
 SESSION LOGOUT
+
+# X server resets
 XSERVER :.* DISCONNECT-CLIENTS
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-manual.script b/tests/scripts/login-gobject-manual.script
index 98b231e3..3c34dbdd 100644
--- a/tests/scripts/login-gobject-manual.script
+++ b/tests/scripts/login-gobject-manual.script
@@ -1,3 +1,7 @@
+#
+# Check can login without a username, and is prompted for one
+#
+
 RUNNER DAEMON-START
 
 # X server starts
diff --git a/tests/scripts/login-gobject-no-password.script b/tests/scripts/login-gobject-no-password.script
index b1c8beb2..83584b52 100644
--- a/tests/scripts/login-gobject-no-password.script
+++ b/tests/scripts/login-gobject-no-password.script
@@ -1,11 +1,15 @@
+#
+# Check can login without password for accounts that do not have a password
+#
+
 RUNNER DAEMON-START
 
-# Start X server
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
 
-# Start greeter
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
diff --git a/tests/scripts/login-gobject-session-crash.script b/tests/scripts/login-gobject-session-crash.script
index ff19a5b7..9be7c04a 100644
--- a/tests/scripts/login-gobject-session-crash.script
+++ b/tests/scripts/login-gobject-session-crash.script
@@ -1,29 +1,49 @@
+#
+# Check if session crashes then returned to greeter
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login as alice
 GREETER LOGIN USERNAME=alice
 GREETER SHOW-PROMPT TEXT="Password:"
 GREETER RESPOND TEXT="password"
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=TRUE
 GREETER QUIT
+
+# Session starts
 SESSION START USER=alice
 XSERVER :.* ACCEPT-CONNECT
 SESSION CONNECT-XSERVER
+
+# Session crashes
 SESSION CRASH
+
+# X server resets
 XSERVER :.* DISCONNECT-CLIENTS
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts on X server
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-wrong-password.script b/tests/scripts/login-gobject-wrong-password.script
index 085dd597..638d5f08 100644
--- a/tests/scripts/login-gobject-wrong-password.script
+++ b/tests/scripts/login-gobject-wrong-password.script
@@ -1,16 +1,28 @@
+#
+# Check can't login with an invalid password
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login with invalid password
 GREETER LOGIN USERNAME=alice
 GREETER SHOW-PROMPT TEXT="Password:"
 GREETER RESPOND TEXT="rubbish"
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=FALSE
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/login-gobject-xserver-crash.script b/tests/scripts/login-gobject-xserver-crash.script
index 6b2a79bc..2fded207 100644
--- a/tests/scripts/login-gobject-xserver-crash.script
+++ b/tests/scripts/login-gobject-xserver-crash.script
@@ -1,3 +1,7 @@
+#
+# Check LightDM returns to the greeter if the X server crashes inside a session
+#
+
 RUNNER DAEMON-START
 
 # XServer starts
diff --git a/tests/scripts/login-gobject.script b/tests/scripts/login-gobject.script
index ef6d9f0b..53f23c88 100644
--- a/tests/scripts/login-gobject.script
+++ b/tests/scripts/login-gobject.script
@@ -1,20 +1,34 @@
+#
+# Check can login
+#
+
 RUNNER DAEMON-START
+
+# X server starts
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# Greeter starts
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Login
 GREETER LOGIN USERNAME=alice
 GREETER SHOW-PROMPT TEXT="Password:"
 GREETER RESPOND TEXT="password"
 GREETER AUTHENTICATION-COMPLETE AUTHENTICATED=TRUE
 GREETER QUIT
+
+# Session starts
 SESSION START USER=alice
 XSERVER :.* ACCEPT-CONNECT
 SESSION CONNECT-XSERVER
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (SESSION TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/no-config.script b/tests/scripts/no-config.script
index f9077b87..3ca9cf4a 100644
--- a/tests/scripts/no-config.script
+++ b/tests/scripts/no-config.script
@@ -1,12 +1,22 @@
+#
+# Check LightDM runs without configuration
+#
+
 RUNNER DAEMON-START
+
+# One X server should start by default
 XSERVER :.* START
 XSERVER :.* INDICATE-READY
 XSERVER :.* ACCEPT-CONNECT
+
+# A greeter should run on the X server
 GREETER START
 XSERVER :.* ACCEPT-CONNECT
 GREETER CONNECT-XSERVER :.*
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
+
+# Cleanup
 *STOP-DAEMON
 # Don't know what order they will terminate
 (GREETER TERMINATE SIGNAL=15|XSERVER :.* TERMINATE SIGNAL=15)
diff --git a/tests/scripts/show-greeter.script b/tests/scripts/show-greeter.script
index 37c1c705..d0312668 100644
--- a/tests/scripts/show-greeter.script
+++ b/tests/scripts/show-greeter.script
@@ -1,3 +1,7 @@
+#
+# Use D-Bus interface to show the greeter
+#
+
 RUNNER DAEMON-START
 *WAIT
 
diff --git a/tests/scripts/switch-to-guest.script b/tests/scripts/switch-to-guest.script
index d3d8be72..f0cb576e 100644
--- a/tests/scripts/switch-to-guest.script
+++ b/tests/scripts/switch-to-guest.script
@@ -1,3 +1,7 @@
+#
+# Check D-Bus interface can trigger/switch to guest session
+#
+
 RUNNER DAEMON-START
 *WAIT
 
diff --git a/tests/scripts/switch-to-user.script b/tests/scripts/switch-to-user.script
index 8ff2c89f..b0153d07 100644
--- a/tests/scripts/switch-to-user.script
+++ b/tests/scripts/switch-to-user.script
@@ -1,3 +1,7 @@
+#
+# Check that a logged in session can be switched to via the D-Bus interface.
+#
+
 RUNNER DAEMON-START
 *WAIT
 
diff --git a/tests/scripts/xdmcp-login.script b/tests/scripts/xdmcp-login.script
index 2baba6ab..c127116e 100644
--- a/tests/scripts/xdmcp-login.script
+++ b/tests/scripts/xdmcp-login.script
@@ -1,7 +1,11 @@
+#
+# Check that LightDM correctly negotiates the XDMCP and starts the session to the remote server.
+#
+
 RUNNER DAEMON-START
 *WAIT 1
 
-# Start an X server to log in with XDMCP
+# Start a remote X server to log in with XDMCP
 *START-XSERVER ARGS=":98 -query localhost -port 9999"
 XSERVER :98 START
 XSERVER :98 SEND-QUERY
@@ -13,14 +17,14 @@ XSERVER :98 GOT-ACCEPT SESSION-ID=[0-9]* AUTHENTICATION-NAME="" AUTHORIZATION-NA
 XSERVER :98 SEND-MANAGE SESSION-ID=[0-9]* DISPLAY-NUMBER=98 DISPLAY-CLASS="DISPLAY CLASS"
 XSERVER :98 ACCEPT-CONNECT
 
-# A greeter should start and connect to this X server
+# Greeter starts and connects to remote X server
 GREETER START
 XSERVER :98 ACCEPT-CONNECT
 GREETER CONNECT-XSERVER 127.0.0.1:98
 GREETER CONNECT-TO-DAEMON
 GREETER CONNECTED-TO-DAEMON
 
-# User logs in
+# Log in
 GREETER LOGIN USERNAME=alice
 GREETER SHOW-PROMPT TEXT="Password:"
 GREETER RESPOND TEXT="password"
diff --git a/tests/scripts/xserver-fail-start.script b/tests/scripts/xserver-fail-start.script
index 26b2b2e2..b7d9881f 100644
--- a/tests/scripts/xserver-fail-start.script
+++ b/tests/scripts/xserver-fail-start.script
@@ -1,3 +1,6 @@
+#
+# Check that LightDM handles an X server that fails to start.
+#
 RUNNER DAEMON-START
 XSERVER :.* START
 XSERVER :.* EXIT CODE=1