Differences

This shows you the differences between two versions of the page.

--- services:labtest:start [2025/09/22 21:30] – [5. Restrict IP Addresses Which Can Access Your eClass Quiz From Within eClass] jas
+++ services:labtest:start [2026/08/21 15:30] (current) – jas
@@ Line 47: / Line 47: @@
 In order to setup your labtest, login to an EECS system via [[https://remotelab.eecs.yorku.ca|remotelab]], then follow these instructions:
-Open a Terminal, then start Labtest Assistant (labtest command) and pass in the concatenation of your course number and section (eg. 7777A for EECS7777A) followed by a space and then a test version name (eg. labtest1).  For example, for course EECS7777A if you're having a test that you want to call labtest1:
+Open a Terminal (click "Activities" in the upper left corner, then click on "Terminal"), then start Labtest Assistant (labtest command) and pass in the concatenation of your course number and section (eg. 7777A for EECS7777A) followed by a space and then a test version name (eg. labtest1).  For example, for course EECS7777A if you're having a test that you want to call labtest1:
 <code>
@@ Line 84: / Line 84: @@
 </code>
-By default, the default start page for your labtest is called "index.html".   It will be opened in a GUI HTML editor.  This makes it easy for you to edit the start page whether or not you know HTML.  If you prefer to use the "vi" text editor, use the "edit" command instead of "gedit":
+By default, the default start page for your labtest is called "index.html".   It will be opened in a GUI HTML editor.  This makes it easy for you to edit the start page whether or not you know HTML.  If you prefer to use the "vi" text editor instead, use the "edit" command instead of "gedit":
 <code>
@@ Line 90: / Line 90: @@
 </code>
-Modify the default page, and add your own information such as your rules for the test, and links to other content.  Change the index.html file, and customize it for your test.  By default, index.html includes a link to the file "labtest.pdf".  This file is intended to contain your labtest questions in PDF format.  If you don't want to use this filename, you can change the name to whatever you like.
+Modify the default start page, and add your own information such as your rules for the test, and links to other content such as slides or documentation.  Change the index.html file, and customize it for your test.  By default, index.html includes a link to the file "labtest.pdf".  This file is intended to contain your labtest questions in PDF format.  If you don't want to use this filename, you can change the name to whatever you like.
-NOTE: If you're creating a labtest which points to an eClass quiz, you'll want to include a link to your quiz directly on this page.  It will look like this: https://eclass.yorku.ca/mod/quiz/view.php?id=12345 (you'll need to find the ID for your quiz)
+NOTE: If you're creating a labtest which points to an eClass quiz, you'll want to include a link to your quiz directly on this page.  It will look like this: https://eclass.yorku.ca/mod/quiz/view.php?id=12345 (you'll need to find the ID for your quiz by logging into eClass)
 After you finish editing index.html, save the file.
@@ Line 105: / Line 105: @@
 Put success.
 </code>
+You can also upload other files like slides, or documentation, and make that available to students in your test.
 Labtest Assistant will ensure that file permissions are setup correctly.
@@ Line 144: / Line 146: @@
 <code>
 Labtest (7777A) [labtest1] > help
+Available commands:
 status                                       Display labtest status
@@ Line 162: / Line 166: @@
 quit                                         Quit
+app help                                     Display app help options
+eecsvm help                                  Display eecsvm help options
 lock help                                    Display lock help options
 ltinit help                                  Display ltinit help options
@@ Line 180: / Line 186: @@
   * You can use the "restore" command to restore student files should they forget to submit.
-There are also a few subcommands in Labtest Assistant - lock, ltinit, restrict, and submit which will be described below.
+There are various subcommands in Labtest Assistant - app, eecsvm, lock, ltinit, restrict, and submit, which will be described below.
+===== Labtest Applications Help =====
+<code>
+Labtest (7777A) [labtest1] > app help
+Labtest Application Dock Help:
+In labtest mode, you can specify which applications are available on the app dock at the bottom of the
+screen.
+These applications are ALWAYS included no matter what your settings: Firefox, Logout, and LTRestore
+In labtest lock mode, no additional applications are added by default unless you add them using "app add".
+DISCLAIMER: Not all applications are suitable for labtest lock mode.  For example, VSCode
+            requires access to the terminal for compiling and debugging code.
+            Consult with tech when adding new applications in lock mode.
+In regular labtest mode, these other applications are added by default:
+org.gnome.Ptyxis
+eclipse
+org.gnome.Nautilus
+NOTE: If you add an app, but still want some of the defaults, you will have to re-add the defaults.
+NOTE:
+app default                                Delete custom app list
+app list                                   List custom app list
+app add <app>                              Add app to custom app list
+app delete <app>                           Delete app from custom app list
+app edit                                   Edit app list in text editor
+app help                                   Display this help text
+</code>
+===== EECSVM Help =====
+<code>
+Labtest (7777A) [labtest1]  > eecsvm help
+EECSVM Mode Help:
+The EECSVM service allows students to use virtual machines required by courses
+they are taking. The service is only available to students enrolled in courses
+requiring this service, and the respective faculty.
+By default, EECSVM service is NOT available in Labtest mode.  It can be enabled
+(or disabled) with the options below.  When enabled, users do not have access
+to VMs that they have created outside of Labtest mode - only the template VMs.
+eecsvm enable                               Enable EESCVM mode
+eecsvm disable                              Disable EECSVM mode
+eecsvm help                                 Display this help text
+For more information on EECSVM service, please refer to this page:
+https://wiki.eecs.yorku.ca/dept/tdb/services:eecsvm
+</code>
 ===== Labtest Lock =====
@@ Line 191: / Line 257: @@
 In labtest lock mode, the student is placed in a limited environment
 with no access to a terminal.  By default, the only application available
-is Firefox web browser.  Additional applications can be made available.
+is Firefox web browser.  Additional applications can be made available
+(see "apps help").
 lock enable                                 Enable lock mode
 lock disable                                Disable lock mode
-lock list                                   List apps in lock mode
-lock add <app> [<opts>] [<display-name>]    Add app to lock mode
-lock delete <app>                           Delete app from lock mode
-lock help                                   Display this help text
-NOTE: As there is no access to a terminal, apps must bring up a GUI.
-Example:
 Enable lock mode (by default includes Web browser access only):
@@ Line 208: / Line 267: @@
 > lock enable
-Want to make Eclipse available in lock mode?
+Disable lock mode:
-> lock add eclipse
+> lock disable
-Add Matlab to lock mode (requires the option -desktop):
-> lock add matlab -desktop
-DISCLAIMER: Not all applications are suitable for lock mode.  For example, VSCode
-            requires access to the terminal for compiling and debugging code.
 </code>
@@ Line 296: / Line 349: @@
 ====== Requesting Labtest Mode ======
-Each term, the technical team books a significant number of labtests.  Please help us to make the process more efficient by ensuring that your labtest booking request contains all the required information in the proper format.
+Each term, the technical team books a significant number of labtests for faculty.  Please help us to make the process more efficient by ensuring that your labtest booking request contains all the required information in the proper format.
 The **first time** in a term when you book a labtest for a course, please provide us with:
@@ Line 305: / Line 358: @@
   * EECS TA user IDs (they will be able to help students move between machines in a labtest) (eg. johns, alicez, aigha) (*)
-(*) Please make sure that you **only send us EECS user IDs** - not full names, not gmail, or other alternate email.  While EECS usernames should be the same as a users Passport York username, some TAs don't apply for an EECS account, and may not have one yet!  In this case, they won't be able to help your students move between machines during your test.  You can search for a users name [[https://webapp.eecs.yorku.ca/directory|here]] or by using the "finduser" command on our system (eg. finduser abc).  If you find that your TA doesn't have an EECS account, then please insist that they e-mail tech to request an account.  In this case, you can report their PPY username so that when their account is created, it will have access as an admin to your test.
+(*) Before submitting a list of users, **please read this carefully**: Please make sure that you **only send us EECS user IDs** - not full names, not gmail, or other alternate email.  While EECS usernames should be the same as a users Passport York username, some TAs may not have an EECS account yet.  In this case, they won't be able to help your students move between machines during your test.  When you submit a list of usernames, we add it to the booking **as is**.  We don't check the usernames for validity.  You can search for a users name [[https://webapp.eecs.yorku.ca/directory|here]] or by using the "finduser" command on our system (eg. finduser abc).
+If a TA does not have an account, the process for them to get an account depends on the user type:
+  * If your TA is an undergrad, and an EECS student taking an EECS course, and they don't already have an EECS account, kindly ask them to get one with [[https://webapp.eecs.yorku.ca/activ8|Activ8]].
+  * If your TA is an undergrad or grad that is not an EECS student, then **you** (**please not the student**) need to send an email to tech@eecs.yorku.ca with the following information:  (If the student emails us to request an account, we have to check with you which requires multiple emails.  If the request comes from you, we know it is legitimate.)
+    * Student Type: ugrad TA
+    * First name:
+    * Last name:
+    * Student ID:
+    * Passport York Login:
+  * If your TA is an EECS grad, and does not have an EECS account, then **they** need to email tech@eecs.yorku.ca with the following information:
+    * First name:
+    * Last name:
+    * Student ID:
+    * Degree: Msc/PhD
+    * Supervisor:
+    * Passport York login:
+Grad accounts will remain on our system for the duration of the students time in their programme at York.  Undergraduate temporary TA accounts will be deleted at the end of the term.
 For **subsequent** labtest bookings in your course, please always include in your booking:
@@ Line 359: / Line 431: @@
 # labtest1-LAB1
 # version: labtest1-lab1
-/20/2023   09:54 5 labtest ea 01-78
+/20/2023   09:55 5 labtest ea 01-78
 /20/2023   11:45 5 default ea 01-78
 </code>
@@ Line 365: / Line 437: @@
 Description:
-  * On June 20, 2023 at 9:54 AM, machines ea01-ea78 in las1006 will display (to logged in users) a warning that the machines will reboot in 5 minutes into labtest mode.  The machines will remind students once per minute until the 5 minutes have elapsed.
+  * On June 20, 2023 at 9:55 AM, machines ea01-ea78 in las1006 will display (to logged in users) a warning that the machines will reboot in 5 minutes into labtest mode.  The machines will remind students once per minute until the 5 minutes have elapsed. (You could also use "4" instead of "5" in the third column to give 4 minutes of warnings, and a reboot at 9:59 so the machines are ready by 10.)
-  * The machines will reboot into labtest mode at 9:59 AM, so they should be ready by 10:00 AM.
+  * The machines will reboot into labtest mode at 9:55 AM, so they should be ready by 10:00 AM.
   * On June 20, 2023 at 11:45 AM, machines ea01-ea78 in las1006 will display (to logged in users) a warning that the machines will reboot back to Linux mode in 5 minutes.  The machines will remind students once per minute until the 5 minutes have elapsed.
-  * At 11:50 PM, machines will reboot from Labest mode back to Linux mode.
+  * At 11:50 PM, machines will reboot from Labtest mode back to Linux mode.
 **Please ensure that your labtest ends 10 minutes prior to the end of your lab booking time.**  For example, if your lab time is 10:00 AM - 11:30 AM, then the students should receive their 5 minute warning at 11:45 AM, then the machines will reboot at 11:50 AM.
@@ Line 377: / Line 449: @@
 # labtest1-LAB1
 # version: labtest1-lab1
-/20/2023   09:54 5 labtest ea 01-78
+/20/2023   09:55 5 labtest ea 01-78
 /20/2023   11:45 5 default ea 01-78
 </code>
@@ Line 386: / Line 458: @@
 # labtest1-LAB1 MAIN
 # version: labtest1-lab1
-/20/2023   09:54 5 labtest ea 01-70
+/20/2023   09:55 5 labtest ea 01-70
 /20/2023   11:45 5 default ea 01-70
 # labtest1-LAB1 ACCOMMODATION - 5 machines getting extra hour
 # version: labtest1-lab1
-/20/2023   09:54 5 labtest ea 71-75
+/20/2023   09:55 5 labtest ea 71-75
 /20/2023   12:45 5 default ea 71-75
 # labtest1-LAB1 ACCOMMODATION - 2 students getting extra 30 minutes
 # version: labtest1-lab1
-/20/2023   09:54 5 labtest ea 76-77
+/20/2023   09:55 5 labtest ea 76-77
 /20/2023   12:15 5 default ea 76-77
 # labtest1-LAB1 ACCOMMODATION - 1 student getting extra 20 minutes
 # version: labtest1-lab1
-/20/2023   09:54 5 labtest ea78
+/20/2023   09:55 5 labtest ea78
 /20/2023   12:05 5 default ea78
 </code>
@@ Line 433: / Line 505: @@
 After you have submitted your labtest booking, someone from tech will get back to you to confirm your booking.  If you don't get back a confirmation email from tech, then your session has **not** been booked.  You can check the labtest booking schedule [[http://www.eecs.yorku.ca/schedule/pcmode/|here]] at any time.
+===== Reserving Additional Lab Time for Accommodations =====
+You can now view the [[https://www.eecs.yorku.ca/schedule/lab|Lab Schedule]] online.  This includes all the lab bookings **AND** extra lab bookings (at the bottom).  If you need to book additional lab time outside of your lab session for accomodations, first consult the schedule and extra bookings to check for availability of extra time.  Ask tech to reserve that time for you.  Once a lab is reserved for your use, you can now use that additional block of time in your labtest booking request.
 If you have any questions about labtest booking, please e-mail the technical team.
@@ Line 920: / Line 996: @@
 Now if you test your labtest in ltcloud, the user will only be able to access the Firefox web browser.
-If you want additional software to be accessible in labtest, it must use a GUI.  You add to the lock file lines of the following format:
+If you want additional software to be accessible in labtest, create a file in the labtest folder called "apps" (eg. /eecs/dept/www/course/9999/labtest/default/apps).  The file contains a list of ".desktop" files available on the system for Applications that you wish to be included in the app dock at the bottom of the screen. A .desktop file is a plain text configuration file used in Linux and Unix-like operating systems to create application shortcuts, define program launchers, and integrate software into a desktop environment's application menu.
-  <app name>,<OPTIONAL app arguments>,<OPTIONAL app display name>
+These applications are ALWAYS included no matter what your settings: Firefox, Logout, and LTRestore
-For example, if you want Eclipse to be available in lock mode, you would add to the lock file:
+In labtest lock mode, no additional applications are added by default unless you add them to the app file.
-  eclipse
+**DISCLAIMER: Not all applications are suitable for labtest lock mode.  For example, VSCode requires access to the terminal for compiling and debugging code. Consult with tech when adding new applications in lock mode. **
-By default, there are no optional arguments, and if no alternate display name is mentioned, then it will appear in the menu with the same name as the command name, but with the first letter capitalized ("Eclipse").
+In regular labtest mode, these other applications are added by default:
-If you want to add Matlab:
+org.gnome.Ptyxis (this is the terminal)
+eclipse
+org.gnome.Nautilus (this is the file manager)
-  matlab,-desktop
+If you want to add an app, you need to find the desktop file for the app.  Desktop files are located in /eecs/local/share/applications/*.desktop.
-In order to run "Matlab", we have to pass "-desktop".  It would appear in the menu as "Matlab".
+If you add an app, but still want some of the defaults to appear, you have to add the defaults back as well.  For example, if you want to add IntelliJ, but you want to continue with the existing defaults, then create the "app" file containing:
-On the other hand, if you wanted to include Visual Studio Code, you would add:
+idea <- that's intellij
+org.gnome.Ptyxis (this is the terminal)
+eclipse
+org.gnome.Nautilus (this is the file manager)
-  code,,Visual Studio Code
+** Please ensure that you're careful when allowing access to software in lock mode.  Giving access to additional software may have unintended side effects.  For example, if you allow access to Eclipse, then students can compile and run code which can give access to system resources that would otherwise not be available.  Access to a terminal is still blocked. **
-Now, "Visual Studio Code" will be displayed in the menu, but it will execute the command "code".
-In labtest lock mode, the window environment is a little different in order to support the locked down nature of the environment.
-When labtest mode is started, a web browser will appear with the labtest start page.  Additional software will be available by right clicking the desktop, or by clicking on the "Apps & Logout" menu in the bottom left corner of the desktop.
-Please ensure that you're careful when allowing access to software in lock mode.  Giving access to additional software may have unintended side effects.  For example, if you allow access to Eclipse, then students can compile and run code which can give access to system resources that would otherwise not be available.  Access to a terminal is still blocked.
 ====== Accessing External Hosts In Labtest (optional) ======
@@ Line 1093: / Line 1166: @@
 In this section, we will configure labtest to provide secure access to an eClass quiz.
-===== 1.  Allow Lab Machines Limited Access To eClass In Labtest Mode =====
+===== 1.  Allow Lab Machines To Access eClass In Labtest Mode =====
 First, you need to allow the lab machines limited access to eClass in labtest mode.
@@ Line 1179: / Line 1252: @@
 NOTES:
-  * If you are using all 3 of WSC105, WSC106, AND WSC108, use instead: 130.63.131.0/24
+  * If you are using all 3 of WSC105, WSC106, AND WSC108, use instead: 130.63.131.0/24 --- however, if you're only using say 1 of the labs, and use 130.63.131.0/24, then the other 2 labs will be able to access your quiz **outside** of labtest mode.
   * If you are testing in ltcloud, please ensure that you include both the IP range for the required lab followed by a comma followed by the ltcloud range.
   * If your test is being conducted in several labs, you can join two IP ranges with a comma in between them.  Note though that if the number of IP ranges separated by commas exceeds around 14, the IP restrictions will not function correctly due to an eClass bug.  Please consult with tech to test your IP range prior to your test.
@@ Line 1186: / Line 1259: @@
 You will need to limit the start and end time of your quiz in eClass.  If you don't do this, then students on the lab machines will be able to access your quiz **before** your labtest!  Go to: Activities >> Quizzes >> Settings >> Timing and configure the "Open the quiz" and "Close the quiz" times.  Note that if students try to access the quiz before the open time, they will be denied because eclass will try to redirect them back to the course eclass page which has been blocked.  They should try again at the start time of your test.
+===== 7. Lock Access to eClass Only (optional) =====
+If you want your students to only be able to access eClass, and no additional software on our systems (eg. Eclipse/VScode), then you will configure Labtest "lock" mode.
+If you're using Labtest Assistant, use the command: lock enable
+If you're not using Labtest Assistant, then touch the file called "lock" in your labtest directory:
+  % touch /eecs/dept/www/course/MYCOURSE/labtest/labtest1/lock
+  % chmod 644 /eecs/dept/www/course/MYCOURSE/labtest/labtest1/lock
 Final Notes:
@@ Line 1535: / Line 1619: @@
 Sometimes, during labtest mode, you may require a student to move from one machine to another machine.  This may be because the student is in the wrong area of the lab, or because there is some failure on the machine (eg. monitor).  Labtest home directories are stored on the local machine, and not a network drive.  Moving a student to another machine without some mechanism to copy student files from one machine to the other would mean starting with a brand new home directory, no files, and an unhappy student!
-When a student moves from one machine to the another, and logs in, the system will check if the student has files from another machine stored in the labtest save cache.  If they do, the student will see the following message: "Welcome!  It seems you have worked on this labtest on another machine.  You may ask one of the test supervisors for approval to transfer your work to this machine, or, hit Cancel to start again.".  At this point, if the student hits "Cancel", then they are logged in with a new environment without restoring their files.  If they want to restore their files from another machine, they need either **your** or your TAs approval!
+When a student moves from one machine to the another, files are not copied automatically.  Once the student logs in, they should click on the "LTRestore" icon which is located on the dock at the bottom of the screen.  The student will see the following message: "This app allows a labtest administrator to restore your work fro ma previous session. Do you need to restore work from a previous session?".  If they click "Yes", then either the faculty or the TA (who has been specified in the admin list for the labtest) must authenticate.
 To restore a students files from another machine, you will need to enter 3 pieces of information -- Labtest Admin (userid), Password, and Restore Machine.  Select the labtest admin from the dropdown list.  The labtest admins are specified by you when you request labtest mode.  The admins are also displayed in the pcmode schedule.  It's important that you check the list of admins before every labtest because neither the lab monitor nor tech staff will be able to restore a students files.   After selecting your name from the admin list, enter your system password.   Next, under "Restore Machine", a dropdown box lists all the machines where the student has been.  Select a machine from which you wish to restore the students files, and click "OK".