Commit d4644ca9b1364d3ba34c9b112eeb5317983afe49

Authored by Kevin Mach
Exists in master

Merge branch 'master' of git.ucsd.edu:110swag/docs

Showing 2 changed files Inline Diff

DesignUseCases.tex View file @ d4644ca
\documentclass[letterpaper]{scrartcl} % or whatever 1 1 \documentclass[letterpaper]{scrartcl} % or whatever
\usepackage{tgpagella} 2 2 \usepackage{tgpagella}
\setkomafont{disposition}{\normalfont\bfseries} 3 3 \setkomafont{disposition}{\normalfont\bfseries}
%\usepackage[markuppercase]{scrpage2} 4 4 %\usepackage[markuppercase]{scrpage2}
\title{\huge Design Use Cases} 5 5 \title{\huge Design Use Cases}
\date{\today} 6 6 \date{\today}
\author{\Large Students With A Goal (S.W.A.G.)} 7 7 \author{\Large Students With A Goal (S.W.A.G.)}
\usepackage[pass]{geometry} 8 8 \usepackage[pass]{geometry}
\usepackage{hyperref} 9 9 \usepackage{hyperref}
\usepackage{graphicx} 10 10 \usepackage{graphicx}
\usepackage{enumitem} 11 11 \usepackage{enumitem}
\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf} 12 12 \setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}
\setlistdepth{9} 13 13 \setlistdepth{9}
14 14
\setlist[itemize,1]{label=$\bullet$} 15 15 \setlist[itemize,1]{label=$\bullet$}
\setlist[itemize,2]{label=$\bullet$} 16 16 \setlist[itemize,2]{label=$\bullet$}
\setlist[itemize,3]{label=$\bullet$} 17 17 \setlist[itemize,3]{label=$\bullet$}
\setlist[itemize,4]{label=$\bullet$} 18 18 \setlist[itemize,4]{label=$\bullet$}
\setlist[itemize,5]{label=$\bullet$} 19 19 \setlist[itemize,5]{label=$\bullet$}
\setlist[itemize,6]{label=$\bullet$} 20 20 \setlist[itemize,6]{label=$\bullet$}
\setlist[itemize,7]{label=$\bullet$} 21 21 \setlist[itemize,7]{label=$\bullet$}
\setlist[itemize,8]{label=$\bullet$} 22 22 \setlist[itemize,8]{label=$\bullet$}
\setlist[itemize,9]{label=$\bullet$} 23 23 \setlist[itemize,9]{label=$\bullet$}
\renewlist{itemize}{itemize}{9} 24 24 \renewlist{itemize}{itemize}{9}
\begin{document} 25 25 \begin{document}
\maketitle 26 26 \maketitle
\begin{center} 27 27 \begin{center}
\includegraphics[width=12cm]{../swag_logo.png}\\ 28 28 \includegraphics[width=12cm]{../swag_logo.png}\\
29 29
\begin{tabular}{l r} 30 30 \begin{tabular}{l r}
Melody Jeng & System Architect \\ 31 31 Melody Jeng & System Architect \\
Arno Gau & Senior System Analyst \\ 32 32 Arno Gau & Senior System Analyst \\
Rachel Lee & Software Development Lead \\ 33 33 Rachel Lee & Software Development Lead \\
Laura Hawkins & Project Manager \\ 34 34 Laura Hawkins & Project Manager \\
Rohan Rangray & Algorithms Specialist\\ 35 35 Rohan Rangray & Algorithms Specialist\\
Andrew Buss & Database Specialist \\ 36 36 Andrew Buss & Database Specialist \\
Phuong Tran & Quality Assurance Lead \\ 37 37 Phuong Tran & Quality Assurance Lead \\
Chung Kang Wang & Business Analyst\\ 38 38 Chung Kang Wang & Business Analyst\\
Masud Rahman & User Interface Specialist\\ 39 39 Masud Rahman & User Interface Specialist\\
Kevin Mach & User Interface Specialist\\ 40 40 Kevin Mach & User Interface Specialist\\
\end{tabular} 41 41 \end{tabular}
\end{center} 42 42 \end{center}
\newpage 43 43 \newpage
\tableofcontents 44 44 \tableofcontents
\newpage 45 45 \newpage
46 46
\section{Accounts} 47 47 \section{Accounts}
\subsection{[A1] User Registration} 48 48 \subsection{[A1] User Registration}
\begin{description}[style=multiline,leftmargin=3cm] 49 49 \begin{description}[style=multiline,leftmargin=3cm]
\item[Description]{To create flashcards and save them into decks, the system requires the user to create an account prior. The user will be able to create an account by registering.} 50 50 \item[Description]{To create flashcards and save them into decks, the system requires the user to create an account prior. The user will be able to create an account by registering.}
\item[Desired Outcome]{An account will be created for the user from the 51 51 \item[Desired Outcome]{An account will be created for the user from the
specified username, password, and email. The user will be able to log into 52 52 specified username, password, and email. The user will be able to log into
the aforementioned account.} 53 53 the aforementioned account.}
\\ 54 54 \\
\item[User Goals]{The user shall have an account to participate in the 55 55 \item[User Goals]{The user shall have an account to participate in the
application's activities.} 56 56 application's activities.}
57 57
\item[Primary Actor]{User (student)} 58 58 \item[Primary Actor]{User (student)}
59 59
\item[Dependency Use Cases]{None} 60 60 \item[Dependency Use Cases]{None}
\\ 61 61 \\
\item[Priority Level]{``Must''} 62 62 \item[Priority Level]{``Must''}
63 63
\item[Status]{Implemented} 64 64 \item[Status]{Implemented}
65 65
\item[Pre-conditions]{None} 66 66 \item[Pre-conditions]{None}
67 67
\item[Post-conditions]{The user has an account registered with the system.} 68 68 \item[Post-conditions]{The user has an account registered with the system.}
69 69
\item[Trigger]{The user wants to create an account.} 70 70 \item[Trigger]{The user wants to create an account.}
71 71
\item[Workflow] 72 72 \item[Workflow]
73 73
\begin{enumerate} 74 74 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 75 75 \itemsep1pt\parskip0pt\parsep0pt
\item 76 76 \item
{The frontend renders the login form described in login.html.} 77 77 {The frontend renders the login form described in login.html.}
\item 78 78 \item
{The user shall click the sign up tab.} 79 79 {The user shall click the sign up tab.}
\item 80 80 \item
{The frontend shall render a registration form and display it to the user.} 81 81 {The frontend shall render a registration form and display it to the user.}
\item 82 82 \item
{The user shall fill in the form.} 83 83 {The user shall fill in the form.}
\item 84 84 \item
{The frontend checks that the provided email is not invalid, and that 85 85 {The frontend checks that the provided email is not invalid, and that
the password is not invalid. If anything is not valid, it displays an 86 86 the password is not invalid. If anything is not valid, it displays an
error and returns this to the user. } 87 87 error and returns this to the user. }
\item 88 88 \item
{If the form is valid, the frontend POSTs the form in JSON format to the 89 89 {If the form is valid, the frontend POSTs the form in JSON format to the
backend API at /api/verify\_email/.} 90 90 backend API at /api/verify\_email/.}
\item 91 91 \item
{The backend deserializes and validates the data in /api/register. If it's not valid, it returns an error to the frontend.} 92 92 {The backend deserializes and validates the data in /api/register. If it's not valid, it returns an error to the frontend.}
\item 93 93 \item
{The backend creates a new user object from the provided data, filling 94 94 {The backend creates a new user object from the provided data, filling
in the email and password fields in models.py in model method create\_user.} 95 95 in the email and password fields in models.py in model method create\_user.}
\item 96 96 \item
{The backend saves the user object in models.py.} 97 97 {The backend saves the user object in models.py.}
\item 98 98 \item
{The backend marks the user's email as unverified.} 99 99 {The backend marks the user's email as unverified.}
\item 100 100 \item
{The backend sends an email to the user's address with a link to validate the user's email address from models.py in function send\_confirmation\_email.} 101 101 {The backend sends an email to the user's address with a link to validate the user's email address from models.py in function send\_confirmation\_email.}
\item 102 102 \item
{The backend responds with success and logs the user in on a new session for the User.} 103 103 {The backend responds with success and logs the user in on a new session for the User.}
\item 104 104 \item
{The frontend reports success to the user and stores the sessionid for future requests.} 105 105 {The frontend reports success to the user and stores the sessionid for future requests.}
\end{enumerate} 106 106 \end{enumerate}
107 107
{Verification Workflow:} 108 108 {Verification Workflow:}
109 109
\begin{enumerate} 110 110 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 111 111 \itemsep1pt\parskip0pt\parsep0pt
\item 112 112 \item
{The user receives an email with a link to verify their email. The user clicks the link} 113 113 {The user receives an email with a link to verify their email. The user clicks the link}
\item 114 114 \item
{The frontend in VerifyEmailController submits a POST request to the backend.} 115 115 {The frontend in VerifyEmailController submits a POST request to the backend.}
\item 116 116 \item
{The backend validates the code in views.py in function veryify\_email. If the code is not valid, it returns an error to the frontend.} 117 117 {The backend validates the code in views.py in function veryify\_email. If the code is not valid, it returns an error to the frontend.}
\item 118 118 \item
{The backend marks the user's email as confirmed and saves the user object 119 119 {The backend marks the user's email as confirmed and saves the user object
again in models.py in function confirm\_email. The user's account is now active.} 120 120 again in models.py in function confirm\_email. The user's account is now active.}
\item 121 121 \item
{The frontend's VerifyEmailController.js reports success and logs the user in to the application.} 122 122 {The frontend's VerifyEmailController.js reports success and logs the user in to the application.}
\end{enumerate} 123 123 \end{enumerate}
124 124
\end{description} 125 125 \end{description}
126 126
\newpage 127 127 \newpage
\subsection{[A2] User Login} 128 128 \subsection{[A2] User Login}
129 129
\begin{description} 130 130 \begin{description}
\item[Description]{The user is able to login to personal account.} 131 131 \item[Description]{The user is able to login to personal account.}
132 132
\item[Desired Outcome]{The user shall be able to provide their username and 133 133 \item[Desired Outcome]{The user shall be able to provide their username and
password to access their courses and flash cards. The user shall gain 134 134 password to access their courses and flash cards. The user shall gain
access to the list of the courses they have added, and be able to review 135 135 access to the list of the courses they have added, and be able to review
the flash cards they have added to their decks.} 136 136 the flash cards they have added to their decks.}
\\ 137 137 \\
\item[User Goals]{The user wants to resume use of the site on another 138 138 \item[User Goals]{The user wants to resume use of the site on another
device, or use the site after logging out.} 139 139 device, or use the site after logging out.}
140 140
\item[Primary Actor]{User (student)} 141 141 \item[Primary Actor]{User (student)}
142 142
\item[Dependency Use Cases]{{[}A1{]} User Registration} 143 143 \item[Dependency Use Cases]{{[}A1{]} User Registration}
\\ 144 144 \\
\item[Priority Level]{``Must''} 145 145 \item[Priority Level]{``Must''}
146 146
\item[Status]{Implemented} 147 147 \item[Status]{Implemented}
148 148
\item[Pre-conditions] 149 149 \item[Pre-conditions]
150 150
\begin{itemize} 151 151 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 152 152 \itemsep1pt\parskip0pt\parsep0pt
\item 153 153 \item
{The user has registered an account.} 154 154 {The user has registered an account.}
{The user knows their email and password.} 155 155 {The user knows their email and password.}
\end{itemize} 156 156 \end{itemize}
157 157
\item[Post-conditions] 158 158 \item[Post-conditions]
159 159
\begin{itemize} 160 160 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 161 161 \itemsep1pt\parskip0pt\parsep0pt
\item 162 162 \item
{The user can navigate the site and see their data.} 163 163 {The user can navigate the site and see their data.}
\end{itemize} 164 164 \end{itemize}
165 165
\item[Trigger]{The user wants to use the application and its core features.} 166 166 \item[Trigger]{The user wants to use the application and its core features.}
167 167
\item[Workflow] 168 168 \item[Workflow]
169 169
\begin{enumerate} 170 170 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 171 171 \itemsep1pt\parskip0pt\parsep0pt
\item 172 172 \item
{The frontend shall render the login form described in login.html and implemented in LoginController.js} 173 173 {The frontend shall render the login form described in login.html and implemented in LoginController.js}
\item 174 174 \item
{The user shall type in their email and password.} 175 175 {The user shall type in their email and password.}
\item 176 176 \item
{The backend shall verify that the user has submitted their email and password in views.py in function login.} 177 177 {The backend shall verify that the user has submitted their email and password in views.py in function login.}
\item 178 178 \item
{The backend shall check that the user is active in views.py in function login.} 179 179 {The backend shall check that the user is active in views.py in function login.}
\item 180 180 \item
{The backend shall log the user in using the Django login feature.} 181 181 {The backend shall log the user in using the Django login feature.}
\item 182 182 \item
{The frontend shall displays the home page for the user.} 183 183 {The frontend shall displays the home page for the user.}
\end{enumerate} 184 184 \end{enumerate}
\end{description} 185 185 \end{description}
\newpage 186 186 \newpage
187 187
\subsection{[A3] Add a Class} 188 188 \subsection{[A3] Add a Class}
\begin{description} 189 189 \begin{description}
\item[Description]{The user shall be able to add a class and access the 190 190 \item[Description]{The user shall be able to add a class and access the
flashcards associated with that class.} 191 191 flashcards associated with that class.}
192 192
\item[Desired Outcome]{The class shall be connected to the student's account 193 193 \item[Desired Outcome]{The class shall be connected to the student's account
and the user shall have the ability to read and publish flashcards 194 194 and the user shall have the ability to read and publish flashcards
for this class.} 195 195 for this class.}
\\ 196 196 \\
\item[User Goals]{The user wants to publish flashcards for this class, and 197 197 \item[User Goals]{The user wants to publish flashcards for this class, and
read the flashcards for this class that are published by other users.} 198 198 read the flashcards for this class that are published by other users.}
199 199
\item[Primary Actor]{User (student)} 200 200 \item[Primary Actor]{User (student)}
201 201
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 202 202 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 203 203 Login}
\\ 204 204 \\
\item[Priority Level]{``Must''} 205 205 \item[Priority Level]{``Must''}
206 206
\item[Status]{Implemented} 207 207 \item[Status]{Implemented}
208 208
\item[Pre-conditions] 209 209 \item[Pre-conditions]
210 210
\begin{itemize} 211 211 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 212 212 \itemsep1pt\parskip0pt\parsep0pt
\item 213 213 \item
{The user has registered an account.} 214 214 {The user has registered an account.}
\item 215 215 \item
{The user has successfully logged in to the application.} 216 216 {The user has successfully logged in to the application.}
\end{itemize} 217 217 \end{itemize}
218 218
\item[Post-conditions] 219 219 \item[Post-conditions]
220 220
\begin{itemize} 221 221 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 222 222 \itemsep1pt\parskip0pt\parsep0pt
\item 223 223 \item
{The user can view the flashcards being published for the class and 224 224 {The user can view the flashcards being published for the class and
add them to their deck.} 225 225 add them to their deck.}
\item 226 226 \item
{The user can publish flashcards to be viewed and added by other users 227 227 {The user can publish flashcards to be viewed and added by other users
in the same class.} 228 228 in the same class.}
\end{itemize} 229 229 \end{itemize}
230 230
\item[Trigger]{The user wants to make flashcards and view flashcards for a class.} 231 231 \item[Trigger]{The user wants to make flashcards and view flashcards for a class.}
232 232
\item[Workflow] 233 233 \item[Workflow]
234 234
\begin{enumerate} 235 235 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 236 236 \itemsep1pt\parskip0pt\parsep0pt
\item 237 237 \item
{The user shall click "Add a Class" from the "Classes" drop down menu in the upper left hand corner.} 238 238 {The user shall click "Add a Class" from the "Classes" drop down menu in the upper left hand corner.}
\item 239 239 \item
{The frontend shall navigate to the new page described by addclass.html.} 240 240 {The frontend shall navigate to the new page described by addclass.html.}
\item 241 241 \item
{The user shall begin to type the class department code, course title, course number, or instructor in the text box.} 242 242 {The user shall begin to type the class department code, course title, course number, or instructor in the text box.}
\item 243 243 \item
{The frontend in ClassAddController.js shall send a get request to the backend at api/sections/search/.} 244 244 {The frontend in ClassAddController.js shall send a get request to the backend at api/sections/search/.}
\item 245 245 \item
{The backend shall search the database for the classes matching department code, course title, course number, or instructor in models.py in function search.} 246 246 {The backend shall search the database for the classes matching department code, course title, course number, or instructor in models.py in function search.}
\item 247 247 \item
{The frontend shall show the classes that the backend has found.} 248 248 {The frontend shall show the classes that the backend has found.}
\item 249 249 \item
{The user shall select from the classes the one that they want to add.} 250 250 {The user shall select from the classes the one that they want to add.}
\item 251 251 \item
{The frontend shall enable the 'Add Class' button.} 252 252 {The frontend shall enable the 'Add Class' button.}
\item 253 253 \item
{The user shall click 'Add Class' button to the right of the text box.} 254 254 {The user shall click 'Add Class' button to the right of the text box.}
\item 255 255 \item
{The frontend shall send a post request to api/sections/.} 256 256 {The frontend shall send a post request to api/sections/.}
\item 257 257 \item
{The backend shall in views.py in function enroll shall call the method enroll in models.py.} 258 258 {The backend shall in views.py in function enroll shall call the method enroll in models.py.}
\item 259 259 \item
{The backend in models.py in function enroll shall add the class to the User's sections.} 260 260 {The backend in models.py in function enroll shall add the class to the User's sections.}
\item 261 261 \item
{The frontend shall redirect the user to the class's Live Feed using the ClassAddController.js.} 262 262 {The frontend shall redirect the user to the class's Live Feed using the ClassAddController.js.}
\item 263 263 \item
{The frontend shall present the live feed for the class by using feed.html and FeedController.js.} 264 264 {The frontend shall present the live feed for the class by using feed.html and FeedController.js.}
265 265
\end{enumerate} 266 266 \end{enumerate}
267 267
\item[Alternate Workflow: User is whitelisted.\\] 268 268 \item[Alternate Workflow: User is whitelisted.\\]
\begin{enumerate} 269 269 \begin{enumerate}
\setcounter{enumi}{3} 270 270 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 271 271 \itemsep1pt\parskip0pt\parsep0pt
\item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\} 272 272 \item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\}
\item 273 273 \item
{The user shall select their desired class, which has a whitelist, by clicking on ``Add Class''.} 274 274 {The user shall select their desired class, which has a whitelist, by clicking on ``Add Class''.}
\item 275 275 \item
{The frontend shall submit a POST request to /api/me/sections with 276 276 {The frontend shall submit a POST request to /api/me/sections with
the course ID that the User typed. } 277 277 the course ID that the User typed. }
\item 278 278 \item
{The backend shall check if there is a whitelist for the class that the 279 279 {The backend shall check if there is a whitelist for the class that the
user has selected in models.py at function is\_whitelisted.} 280 280 user has selected in models.py at function is\_whitelisted.}
\item 281 281 \item
{The backend shall check if the user is on the whitelist in models.py 282 282 {The backend shall check if the user is on the whitelist in models.py
in function is\_user\_on\_whitelist.} 283 283 in function is\_user\_on\_whitelist.}
\item 284 284 \item
{The backend shall add the user to the class following steps above.} 285 285 {The backend shall add the user to the class following steps above.}
\item 286 286 \item
{The frontend shall redirect the user to the class's live feed followed the last step in the Workflow above.} 287 287 {The frontend shall redirect the user to the class's live feed followed the last step in the Workflow above.}
\end{enumerate} 288 288 \end{enumerate}
289 289
\item[Alternate Workflow: User is not whitelisted.] 290 290 \item[Alternate Workflow: User is not whitelisted.]
\begin{enumerate} 291 291 \begin{enumerate}
\setcounter{enumi}{7} 292 292 \setcounter{enumi}{7}
\itemsep1pt\parskip0pt\parsep0pt 293 293 \itemsep1pt\parskip0pt\parsep0pt
\item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\} 294 294 \item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\}
\item 295 295 \item
{The backend shall will check that the user is in the whitelist in models.py.} 296 296 {The backend shall will check that the user is in the whitelist in models.py.}
\item 297 297 \item
{The frontend shall display that the class is whitelisted and the Add Class button will not be enabled.} 298 298 {The frontend shall display that the class is whitelisted and the Add Class button will not be enabled.}
\end{enumerate} 299 299 \end{enumerate}
300 300
\end{description} 301 301 \end{description}
{} 302 302 {}
303 303
\newpage 304 304 \newpage
305 305
{} 306 306 {}
307 307
\subsection{[A4] Drop a Class} 308 308 \subsection{[A4] Drop a Class}
309 309
\begin{description} 310 310 \begin{description}
\item[Description]{The user can remove themselves from a course he/she is 311 311 \item[Description]{The user can remove themselves from a course he/she is
registered to} 312 312 registered to}
313 313
\item[Desired Outcome]{The user has dropped the class and no longer need 314 314 \item[Desired Outcome]{The user has dropped the class and no longer need
access to the flashcards for said class. This means they can no longer 315 315 access to the flashcards for said class. This means they can no longer
see the flashcards associated to the class that they dropped } 316 316 see the flashcards associated to the class that they dropped }
\\ 317 317 \\
\item[User Goals]{The user shall not have access to a class and the 318 318 \item[User Goals]{The user shall not have access to a class and the
flashcards associated with that class. They will no longer see the class 319 319 flashcards associated with that class. They will no longer see the class
listed in their drop down menu.} 320 320 listed in their drop down menu.}
321 321
\item[Primary Actor]{User (student)} 322 322 \item[Primary Actor]{User (student)}
323 323
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 324 324 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 325 325 Login, {[}A3{]} Add a Class}
\\ 326 326 \\
\item[Priority Level]{ ``Should''} 327 327 \item[Priority Level]{ ``Should''}
328 328
\item[Status]{Implemented } 329 329 \item[Status]{Implemented }
330 330
\item[Pre-conditions] 331 331 \item[Pre-conditions]
332 332
\begin{itemize} 333 333 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 334 334 \itemsep1pt\parskip0pt\parsep0pt
\item 335 335 \item
{The user has a valid account.} 336 336 {The user has a valid account.}
\item 337 337 \item
{The user is logged in.} 338 338 {The user is logged in.}
\item 339 339 \item
{The user has enrolled in at least one class.} 340 340 {The user has enrolled in at least one class.}
\item 341 341 \item
{The user has navigated to the Settings page.} 342 342 {The user has navigated to the Settings page.}
\end{itemize} 343 343 \end{itemize}
344 344
\item[Post-conditions]{} 345 345 \item[Post-conditions]{}
346 346
\begin{itemize} 347 347 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 348 348 \itemsep1pt\parskip0pt\parsep0pt
\item 349 349 \item
{The user shall no longer have access to dropped class, or associated 350 350 {The user shall no longer have access to dropped class, or associated
flashcards} 351 351 flashcards}
\end{itemize} 352 352 \end{itemize}
353 353
\item[Trigger]{The user no longer wants to see flashcards from that class.} 354 354 \item[Trigger]{The user no longer wants to see flashcards from that class.}
355 355
\item[Workflow] 356 356 \item[Workflow]
357 357
\begin{enumerate} 358 358 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 359 359 \itemsep1pt\parskip0pt\parsep0pt
\item 360 360 \item
{The user shall click `Drop' button to the right of the class they wish to drop.} 361 361 {The user shall click `Drop' button to the right of the class they wish to drop.}
\item 362 362 \item
{The frontend shall submit a DELETE request to 363 363 {The frontend shall submit a DELETE request to
/api/me/sections/\textless{}section ID number\textgreater{}.} 364 364 /api/me/sections/\textless{}section ID number\textgreater{}.}
\item 365 365 \item
{The backend shall check that the user is enrolled in the section in models.py in function drop.} 366 366 {The backend shall check that the user is enrolled in the section in models.py in function drop.}
\item 367 367 \item
{The server shall remove the selected class from a user's list of section in models.py in function drop.} 368 368 {The server shall remove the selected class from a user's list of section in models.py in function drop.}
\item 369 369 \item
{The frontend shall remove the class from the list in setting and show toast reading 'Dropped'.} 370 370 {The frontend shall remove the class from the list in setting and show toast reading 'Dropped'.}
\end{enumerate} 371 371 \end{enumerate}
\end{description} 372 372 \end{description}
\newpage 373 373 \newpage
374 374
{} 375 375 {}
376 376
\subsection{[A5] Password change} 377 377 \subsection{[A5] Password change}
378 378
\begin{description} 379 379 \begin{description}
\item[Description]{The user shall be able to change the password for their 380 380 \item[Description]{The user shall be able to change the password for their
account in the account settings. } 381 381 account in the account settings. }
382 382
\item[Desired Outcome]{The user's password shall be changed and the User 383 383 \item[Desired Outcome]{The user's password shall be changed and the User
shall be able to log in with the new password in the future} 384 384 shall be able to log in with the new password in the future}
\\\\ 385 385 \\\\
\item[User Goals]{The User wants to use a different password in the future} 386 386 \item[User Goals]{The User wants to use a different password in the future}
387 387
\item[Primary Actor]{User (student)} 388 388 \item[Primary Actor]{User (student)}
389 389
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 390 390 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 391 391 Login}
\\ 392 392 \\
\item[Details]{The user provides their current password and a new password 393 393 \item[Details]{The user provides their current password and a new password
in a form. If the current password is correct, the system updates their 394 394 in a form. If the current password is correct, the system updates their
password to the requested new password.} 395 395 password to the requested new password.}
396 396
\item[Priority Level]{``Must''} 397 397 \item[Priority Level]{``Must''}
398 398
\item[Status]{Implemented} 399 399 \item[Status]{Implemented}
400 400
\item[Pre-conditions] 401 401 \item[Pre-conditions]
402 402
\begin{itemize} 403 403 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 404 404 \itemsep1pt\parskip0pt\parsep0pt
\item 405 405 \item
{The user has registered an account.} 406 406 {The user has registered an account.}
\item 407 407 \item
{The user has logged in.} 408 408 {The user has logged in.}
\item 409 409 \item
{The user knows their current password.} 410 410 {The user knows their current password.}
\item 411 411 \item
{The user has navigated to the Settings page.} 412 412 {The user has navigated to the Settings page.}
\end{itemize} 413 413 \end{itemize}
414 414
\item[Post-conditions] 415 415 \item[Post-conditions]
416 416
\begin{itemize} 417 417 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 418 418 \itemsep1pt\parskip0pt\parsep0pt
\item 419 419 \item
{The user's password is changed} 420 420 {The user's password is changed}
\item 421 421 \item
{The user can log in with the new password} 422 422 {The user can log in with the new password}
\end{itemize} 423 423 \end{itemize}
424 424
\item[Trigger]{The user wants to change their password.} 425 425 \item[Trigger]{The user wants to change their password.}
426 426
\item[Error Handling] 427 427 \item[Error Handling]
\begin{description} 428 428 \begin{description}
\item[\small Missing Fields] \begin{itemize} 429 429 \item[\small Missing Fields] \begin{itemize}
\item The frontend shall enforce required fields 430 430 \item The frontend shall enforce required fields
\item The backend will return an HTTP Bad Request error to the frontend. 431 431 \item The backend will return an HTTP Bad Request error to the frontend.
\end{itemize} 432 432 \end{itemize}
\item[\small Incorrect Old Password] \begin{itemize} 433 433 \item[\small Incorrect Old Password] \begin{itemize}
\item The backend will return an HTTP Forbidden error to the frontend. 434 434 \item The backend will return an HTTP Forbidden error to the frontend.
\end{itemize} 435 435 \end{itemize}
\item[\small Blank New Password] \begin{itemize} 436 436 \item[\small Blank New Password] \begin{itemize}
\item The backend will return an HTTP Bad Request error to the frontend. 437 437 \item The backend will return an HTTP Bad Request error to the frontend.
\end{itemize} 438 438 \end{itemize}
\end{description} 439 439 \end{description}
\item[Workflow] 440 440 \item[Workflow]
441 441
\begin{enumerate} 442 442 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 443 443 \itemsep1pt\parskip0pt\parsep0pt
\item 444 444 \item
{The frontend shall render a form that requires the user to enter their 445 445 {The frontend shall render a form that requires the user to enter their
old password and new password from settings.html} 446 446 old password and new password from settings.html}
\item 447 447 \item
{The user shall type in their current password, the desired new 448 448 {The user shall type in their current password, the desired new
password, and retype the desired new password to confirm.} 449 449 password, and retype the desired new password to confirm.}
\item 450 450 \item
{The frontend shall submit the data to the server by sending a PATCH 451 451 {The frontend shall submit the data to the server by sending a PATCH
request to /api/me containing ``old\_password'' and 452 452 request to /api/me containing ``old\_password'' and
``new\_password'' values in SettingsController.js.} 453 453 ``new\_password'' values in SettingsController.js.}
\item (The ) 454 454 \item (The )
\item 455 455 \item
{The backend shall check the user's current password in views.py in function patch under UserDetail.} 456 456 {The backend shall check the user's current password in views.py in function patch under UserDetail.}
\item The backend shall update the user's current password in views.py in function patch under UserDetail. 457 457 \item The backend shall update the user's current password in views.py in function patch under UserDetail.
\item 458 458 \item
{The frontend shall present a toast reading "Password successfully changed" and redirect the user to the Add a Class page.} 459 459 {The frontend shall present a toast reading "Password successfully changed" and redirect the user to the Add a Class page.}
\end{enumerate} 460 460 \end{enumerate}
\end{description} 461 461 \end{description}
{} 462 462 {}
463 463
\newpage 464 464 \newpage
465 465
{} 466 466 {}
467 467
\subsection{[A6] Password reset} 468 468 \subsection{[A6] Password reset}
469 469
\begin{description} 470 470 \begin{description}
\item[Description]{The user shall be able to reset their password without 471 471 \item[Description]{The user shall be able to reset their password without
being logged in.} 472 472 being logged in.}
473 473
\item[Desired Outcome]{The user's password shall be changed to one that 474 474 \item[Desired Outcome]{The user's password shall be changed to one that
they remember.} 475 475 they remember.}
\\ 476 476 \\
\item[User Goals]{The user will be able to log into the site with a new password.} 477 477 \item[User Goals]{The user will be able to log into the site with a new password.}
478 478
\item[Primary Actor]{User (student)} 479 479 \item[Primary Actor]{User (student)}
480 480
\item[Dependency Use Cases]{{[}A1{]} User Registration} 481 481 \item[Dependency Use Cases]{{[}A1{]} User Registration}
\\ 482 482 \\
\item[Details]{The user provides their email in a password reset form. If 483 483 \item[Details]{The user provides their email in a password reset form. If
the address is valid, the site sends a password reset link with a random 484 484 the address is valid, the site sends a password reset link with a random
token to that address. If the address is invalid, the site does not send 485 485 token to that address. If the address is invalid, the site does not send
a link. For security reasons, we do not reveal to the User whether the 486 486 a link. For security reasons, we do not reveal to the User whether the
email address was valid, and we expire the link after 24 hours. When a 487 487 email address was valid, and we expire the link after 24 hours. When a
user visits the link emailed to them, they are able to specify a new 488 488 user visits the link emailed to them, they are able to specify a new
password in a form. When they submit the form, their password is updated 489 489 password in a form. When they submit the form, their password is updated
if the token is correct. } 490 490 if the token is correct. }
491 491
\item[Priority Level]{``Must''} 492 492 \item[Priority Level]{``Must''}
493 493
\item[Status]{Implemented} 494 494 \item[Status]{Implemented}
495 495
\item[Pre-conditions] 496 496 \item[Pre-conditions]
497 497
\begin{itemize} 498 498 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 499 499 \itemsep1pt\parskip0pt\parsep0pt
\item 500 500 \item
{The user has created an account before.} 501 501 {The user has created an account before.}
\item 502 502 \item
{The user knows the email address attached to their account for our application.} 503 503 {The user knows the email address attached to their account for our application.}
\item 504 504 \item
{The user can log into their email account.} 505 505 {The user can log into their email account.}
\end{itemize} 506 506 \end{itemize}
507 507
\item[Post-conditions] 508 508 \item[Post-conditions]
509 509
\begin{itemize} 510 510 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 511 511 \itemsep1pt\parskip0pt\parsep0pt
\item 512 512 \item
{The user's password is changed.} 513 513 {The user's password is changed.}
\item 514 514 \item
{The user can log in with the new password.} 515 515 {The user can log in with the new password.}
\end{itemize} 516 516 \end{itemize}
517 517
\item[Trigger]{The user wants to log into the site but does not know their password.} 518 518 \item[Trigger]{The user wants to log into the site but does not know their password.}
\item[Workflow] 519 519 \item[Workflow]
520 520
\begin{enumerate} 521 521 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 522 522 \itemsep1pt\parskip0pt\parsep0pt
\item 523 523 \item
{The User clicks ``Forgot Password'' text on the login page} 524 524 {The User clicks ``Forgot Password'' text on the login page}
\item 525 525 \item
{The frontend shall render the password reset page from the template requestpasswordreset.html.} 526 526 {The frontend shall render the password reset page from the template requestpasswordreset.html.}
\item 527 527 \item
{The user shall type in their email address for their account and click the "Reset" button.} 528 528 {The user shall type in their email address for their account and click the "Reset" button.}
\item 529 529 \item
{The frontend shall send a POST request to /api/request\_password\_reset/ from RequestResetController.js.} 530 530 {The frontend shall send a POST request to /api/request\_password\_reset/ from RequestResetController.js.}
\item 531 531 \item
{The backend shall check if an account exists with the email entered by 532 532 {The backend shall check if an account exists with the email entered by
the User in views.py in function request\_password\_reset.} 533 533 the User in views.py in function request\_password\_reset.}
\item 534 534 \item
{The backend shal send an email to the User with a link to the password reset page in models.py in function 535 535 {The backend shal send an email to the User with a link to the password reset page in models.py in function
request\_password\_reset.} 536 536 request\_password\_reset.}
\item 537 537 \item
{The user will navigate to their email account, open the email, and click the link.} 538 538 {The user will navigate to their email account, open the email, and click the link.}
\item 539 539 \item
{The frontend shall render the password reset page from the template resetpassword.html.} 540 540 {The frontend shall render the password reset page from the template resetpassword.html.}
\item 541 541 \item
{The user shall type in their new password and re-type it to confirm it.} 542 542 {The user shall type in their new password and re-type it to confirm it.}
\item 543 543 \item
{The frontend shall check if the new password is long enough and if the confirmed password is the same as the new password in ResetPasswordController.js.} 544 544 {The frontend shall check if the new password is long enough and if the confirmed password is the same as the new password in ResetPasswordController.js.}
\item 545 545 \item
{The frontend shall send a POST request to /api/reset\_password from ResetPasswordController.js.} 546 546 {The frontend shall send a POST request to /api/reset\_password from ResetPasswordController.js.}
\item 547 547 \item
{The backend shall change the user's password in views.py in function reset\_password.} 548 548 {The backend shall change the user's password in views.py in function reset\_password.}
\item 549 549 \item
{The frontend shall redirect the User to the login page. } 550 550 {The frontend shall redirect the User to the login page. }
\item 551 551 \item
{The user shall use their new password to login to the application.} 552 552 {The user shall use their new password to login to the application.}
\end{enumerate} 553 553 \end{enumerate}
\end{description} 554 554 \end{description}
\newpage 555 555 \newpage
556 556
{} 557 557 {}
558 558
\subsection{[A7] Limit Student Access to Courses} 559 559 \subsection{[A7] Limit Student Access to Courses}
560 560
\begin{description} 561 561 \begin{description}
\item[Description]{The instructor shall be able to limit access to the courses that they are in charge of by whitelisting only those students that are actually in the class.} 562 562 \item[Description]{The instructor shall be able to limit access to the courses that they are in charge of by whitelisting only those students that are actually in the class.}
563 563
\item[Desired Outcome]{The class will have limited access and only those Users who are whitelisted may enroll in the class.} 564 564 \item[Desired Outcome]{The class will have limited access and only those Users who are whitelisted may enroll in the class.}
\\ 565 565 \\
\item[User Goals]{The instructor wants to limit access to their class so only 566 566 \item[User Goals]{The instructor wants to limit access to their class so only
the students who are actually in their class participate, and nobody else.} 567 567 the students who are actually in their class participate, and nobody else.}
568 568
\item[Primary Actor]{Instructor} 569 569 \item[Primary Actor]{Instructor}
570 570
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 571 571 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 572 572 Login}
\\ 573 573 \\
\item[Priority Level]{``Should''} 574 574 \item[Priority Level]{``Should''}
575 575
\item[Status]{Implemented} 576 576 \item[Status]{Implemented}
577 577
\item[Pre-conditions] 578 578 \item[Pre-conditions]
579 579
\begin{itemize} 580 580 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 581 581 \itemsep1pt\parskip0pt\parsep0pt
\item 582 582 \item
{The user has valid instructor's account} 583 583 {The user has valid instructor's account}
\end{itemize} 584 584 \end{itemize}
585 585
\item[Post-conditions] 586 586 \item[Post-conditions]
587 587
\begin{itemize} 588 588 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 589 589 \itemsep1pt\parskip0pt\parsep0pt
\item 590 590 \item
{Only those users who were whitelisted may add the class.} 591 591 {Only those users who were whitelisted may add the class.}
\end{itemize} 592 592 \end{itemize}
593 593
\item[Trigger]{The course instructor wants to limit the students who 594 594 \item[Trigger]{The course instructor wants to limit the students who
can add their class on our application.} 595 595 can add their class on our application.}
596 596
\item[Workflow] 597 597 \item[Workflow]
598 598
\begin{enumerate} 599 599 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 600 600 \itemsep1pt\parskip0pt\parsep0pt
\item 601 601 \item
{The instructor emails the administrators from their UCSD email address 602 602 {The instructor emails the administrators from their UCSD email address
and requests to limit access to their course. They provides a list of 603 603 and requests to limit access to their course. They provides a list of
emails of the students that are to be whitelisted.} 604 604 emails of the students that are to be whitelisted.}
\item 605 605 \item
{The administrators visit a custom admin page, select the course, and 606 606 {The administrators visit a custom admin page, select the course, and
paste the list of emails. They submit the page directly (no separate 607 607 paste the list of emails. They submit the page directly (no separate
frontend here) to the server.} 608 608 frontend here) to the server.}
\item 609 609 \item
{The backend shall create a WhitelistedAddress for each provided email, 610 610 {The backend shall create a WhitelistedAddress for each provided email,
attaching it to the section taught by the instructor.} 611 611 attaching it to the section taught by the instructor.}
\item 612 612 \item
{The backend shall add any existing users whose email addresses appear 613 613 {The backend shall add any existing users whose email addresses appear
in the whitelist to the class.} 614 614 in the whitelist to the class.}
\end{enumerate} 615 615 \end{enumerate}
\end{description} 616 616 \end{description}
\newpage 617 617 \newpage
618 618
\subsection{[A8] User Logout} 619 619 \subsection{[A8] User Logout}
620 620
\begin{description} 621 621 \begin{description}
\item[Description]{The user shall be able to log out of their account on 622 622 \item[Description]{The user shall be able to log out of their account on
the site.} 623 623 the site.}
624 624
\item[Desired Outcome]{The user's information and data will no longer be 625 625 \item[Desired Outcome]{The user's information and data will no longer be
accessible after logging out. } 626 626 accessible after logging out. }
\\ 627 627 \\
\item[User Goals]{The user is done with his/her session of using the 628 628 \item[User Goals]{The user is done with his/her session of using the
website, and wants to make sure others cannot access the data in their 629 629 website, and wants to make sure others cannot access the data in their
account.} 630 630 account.}
631 631
\item[Primary Actor]{User (student)} 632 632 \item[Primary Actor]{User (student)}
633 633
\item[Dependency Use Cases] None 634 634 \item[Dependency Use Cases] None
\\ 635 635 \\
\item[Priority Level]{``Must''} 636 636 \item[Priority Level]{``Must''}
637 637
\item[Status]{Implemented} 638 638 \item[Status]{Implemented}
639 639
\item[Pre-conditions]{The user is logged into their account} 640 640 \item[Pre-conditions]{The user is logged into their account}
641 641
\item[Post-conditions]{}{The user's data can no longer be accessed.} 642 642 \item[Post-conditions]{}{The user's data can no longer be accessed.}
643 643
\item[Trigger]{The user no longer wants to be logged into the application.} 644 644 \item[Trigger]{The user no longer wants to be logged into the application.}
645 645
\item[Workflow] 646 646 \item[Workflow]
647 647
\begin{enumerate} 648 648 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 649 649 \itemsep1pt\parskip0pt\parsep0pt
\item 650 650 \item
{The user clicks the 'Logout' button in the upper right hand corner.} 651 651 {The user clicks the 'Logout' button in the upper right hand corner.}
\item 652 652 \item
{The backend shall log the user out using the Django logout feature.} 653 653 {The backend shall log the user out using the Django logout feature.}
\item 654 654 \item
{The frontend renders the application login page using login.html.} 655 655 {The frontend renders the application login page using login.html.}
\end{enumerate} 656 656 \end{enumerate}
657 657
\end{description} 658 658 \end{description}
659 659
\newpage 660 660 \newpage
661 661
662 662
663 663
\subsection{[A9] Contact Admin} 664 664 \subsection{[A9] Contact Admin}
665 665
\begin{description} 666 666 \begin{description}
\item[Description]{The user shall be able to contact the admin.} 667 667 \item[Description]{The user shall be able to contact the admin.}
668 668
\item[Desired Outcome]{The user shall send a message to the admin; the 669 669 \item[Desired Outcome]{The user shall send a message to the admin; the
admin shall receive the message.} 670 670 admin shall receive the message.}
671 671
{User Goals:}{The user sends a message to the admin.} 672 672 {User Goals:}{The user sends a message to the admin.}
673 673
\item[Primary Actor]{User} 674 674 \item[Primary Actor]{User}
675 675
\item[Dependency Use Cases]{None} 676 676 \item[Dependency Use Cases]{None}
\\ 677 677 \\
\item[Priority Level]{``Must''} 678 678 \item[Priority Level]{``Must''}
679 679
\item[Status]{Implemented} 680 680 \item[Status]{Implemented}
681 681
\item[Pre-conditions]{None.} 682 682 \item[Pre-conditions]{None.}
683 683
\item[Post-conditions]{The admin receives the user's message.} 684 684 \item[Post-conditions]{The admin receives the user's message.}
685 685
\item[Trigger]{The user wants to contact the adiminstators of the site with 686 686 \item[Trigger]{The user wants to contact the adiminstators of the site with
bug reports, questions, or praise. } 687 687 bug reports, questions, or praise. }
688 688
\item[Workflow] 689 689 \item[Workflow]
690 690
\begin{enumerate} 691 691 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 692 692 \itemsep1pt\parskip0pt\parsep0pt
\item 693 693 \item
{The user shall click the '?' button in the right corner of the navigation bar.} 694 694 {The user shall click the '?' button in the right corner of the navigation bar.}
\item 695 695 \item
{The frontend shall render the page using the help.html template.} 696 696 {The frontend shall render the page using the help.html template.}
\item 697 697 \item
{The user shall scroll to the bottom of the page.} 698 698 {The user shall scroll to the bottom of the page.}
\item 699 699 \item
{The user shall click the text reading "Send Us an Email!"} 700 700 {The user shall click the text reading "Send Us an Email!"}
\item 701 701 \item
{The frontend shall open Microsoft Outlook or a similar application using the HelpController.js.} 702 702 {The frontend shall open Microsoft Outlook or a similar application using the HelpController.js.}
\item 703 703 \item
{The user shall see our email address in the recipients text box.} 704 704 {The user shall see our email address in the recipients text box.}
\end{enumerate} 705 705 \end{enumerate}
\end{description} 706 706 \end{description}
\newpage 707 707 \newpage
708 708
{} 709 709 {}
\section{Flashcards} 710 710 \section{Flashcards}
\subsection{[F1] Push Flashcard} 711 711 \subsection{[F1] Push Flashcard}
712 712
\begin{description} 713 713 \begin{description}
\item[Description]{The user shall be able to create a flashcard with their 714 714 \item[Description]{The user shall be able to create a flashcard with their
input. } 715 715 input. }
716 716
\item[Desired Outcome]{The user shall have the flashcard added to their own 717 717 \item[Desired Outcome]{The user shall have the flashcard added to their own
deck and the Live Feed. } 718 718 deck and the Live Feed. }
\\ 719 719 \\
\item[User Goals]{The user will see their flashcard in their deck and the 720 720 \item[User Goals]{The user will see their flashcard in their deck and the
flashcard will be shared with others. } 721 721 flashcard will be shared with others. }
722 722
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 723 723 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 724 724 Login, {[}A3{]} Add a Class}
\\ 725 725 \\
\item[Pre-conditions] 726 726 \item[Pre-conditions]
727 727
\begin{itemize} 728 728 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 729 729 \itemsep1pt\parskip0pt\parsep0pt
\item 730 730 \item
{The user has an account.} 731 731 {The user has an account.}
\item 732 732 \item
{The user has added at least one class.} 733 733 {The user has added at least one class.}
\item 734 734 \item
{The user has navigated to the live feed for a class.} 735 735 {The user has navigated to the live feed for a class.}
\end{itemize} 736 736 \end{itemize}
737 737
\item[Post-conditions] 738 738 \item[Post-conditions]
739 739
\begin{itemize} 740 740 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 741 741 \itemsep1pt\parskip0pt\parsep0pt
\item 742 742 \item
{The user has flashcard added to their deck.} 743 743 {The user has flashcard added to their deck.}
\item 744 744 \item
{The Flashcard is shown in the Live Feed.} 745 745 {The Flashcard is shown in the Live Feed.}
\item 746 746 \item
{Other users can add this flashcard to their decks.} 747 747 {Other users can add this flashcard to their decks.}
\end{itemize} 748 748 \end{itemize}
749 749
\item[Trigger]{The user wants to make a flashcard to study.} 750 750 \item[Trigger]{The user wants to make a flashcard to study.}
751 751
\item[Workflow] 752 752 \item[Workflow]
753 753
\begin{enumerate} 754 754 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 755 755 \itemsep1pt\parskip0pt\parsep0pt
\item 756 756 \item
{The user is at the live feed for the class from feed.html.} 757 757 {The user is at the live feed for the class from feed.html.}
\item 758 758 \item
{The user shall click on the '+' button at the bottom right of the screen.} 759 759 {The user shall click on the '+' button at the bottom right of the screen.}
\item 760 760 \item
{The frontend shall present a modal for inputting the flashcard text to the User.} 761 761 {The frontend shall present a modal for inputting the flashcard text to the User.}
\item 762 762 \item
{The user shall type in the content of their flashcard.} 763 763 {The user shall type in the content of their flashcard.}
\item 764 764 \item
{The user shall highlight keywords in the flashcard text.} 765 765 {The user shall highlight keywords in the flashcard text.}
\item 766 766 \item
{The user shall click on the `Contribute' button.} 767 767 {The user shall click on the `Contribute' button.}
\item {The frontend shall generate a POST request consisting of the flashcard text, 768 768 \item {The frontend shall generate a POST request consisting of the flashcard text,
blanks, and material date, in JSON form in FeedController.js and send it to /api/flashcards/.} 769 769 blanks, and material date, in JSON form in FeedController.js and send it to /api/flashcards/.}
\item 770 770 \item
{The backend shall obtain the flashcard information by deserializing 771 771 {The backend shall obtain the flashcard information by deserializing
the JSON in the POST request in views.py.} 772 772 the JSON in the POST request in views.py.}
\item 773 773 \item
{The backend shall create a new record for this flashcard in the 774 774 {The backend shall create a new record for this flashcard in the
Flashcards table in the database in models.py.} 775 775 Flashcards table in the database in models.py.}
\item 776 776 \item
{The frontend shall publish the newly created card to the live feed of 777 777 {The frontend shall publish the newly created card to the live feed of
the class using FeedController.js.} 778 778 the class using FeedController.js.}
\end{enumerate} 779 779 \end{enumerate}
\end{description} 780 780 \end{description}
\newpage 781 781 \newpage
{} 782 782 {}
783 783
\subsection{[F2] Edit Flashcard} 784 784 \subsection{[F2] Edit Flashcard}
785 785
\begin{description} 786 786 \begin{description}
\item[Description]{The User shall be able to duplicate the flashcard authored by a different user and make changes to it.} 787 787 \item[Description]{The User shall be able to duplicate the flashcard authored by a different user and make changes to it.}
788 788
\item[Desired Outcome]{The new flashcard is edited and saved appropriately.} 789 789 \item[Desired Outcome]{The new flashcard is edited and saved appropriately.}
\\ 790 790 \\
\item[User Goals]{To create a flashcard similar to an existing flashcard but with minor changes.} 791 791 \item[User Goals]{To create a flashcard similar to an existing flashcard but with minor changes.}
792 792
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 793 793 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull 794 794 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
Flashcard} 795 795 Flashcard}
796 796
\item[Pre-conditions] 797 797 \item[Pre-conditions]
798 798
\begin{itemize} 799 799 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 800 800 \itemsep1pt\parskip0pt\parsep0pt
\item 801 801 \item
{The flashcard to be edited is visible in the user's feed view or deck view.} 802 802 {The flashcard to be edited is visible in the user's feed view or deck view.}
\item 803 803 \item
{The user is currently in the feed view or the deck view of the course the card to be edited belongs to.} 804 804 {The user is currently in the feed view or the deck view of the course the card to be edited belongs to.}
\end{itemize} 805 805 \end{itemize}
806 806
\item[Post-conditions] 807 807 \item[Post-conditions]
808 808
\begin{itemize} 809 809 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 810 810 \itemsep1pt\parskip0pt\parsep0pt
\item 811 811 \item
{A duplicate flashcard with some differences is created.} 812 812 {A duplicate flashcard with some differences is created.}
\end{itemize} 813 813 \end{itemize}
814 814
\item[Trigger] {The User wants to duplicate a card and make some changes to it and thus create a new flashcard.} 815 815 \item[Trigger] {The User wants to duplicate a card and make some changes to it and thus create a new flashcard.}
\item[Workflow] 816 816 \item[Workflow]
817 817
\begin{enumerate} 818 818 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 819 819 \itemsep1pt\parskip0pt\parsep0pt
\item{The user shall hover over the card to be edited and and click on the 820 820 \item{The user shall hover over the card to be edited and and click on the
pencil button that appears on the bottom left of the card.} 821 821 pencil button that appears on the bottom left of the card.}
\item 822 822 \item
{The frontend shall produce an editable dialog box containing the flashcard 823 823 {The frontend shall produce an editable dialog box containing the flashcard
text } 824 824 text }
\item 825 825 \item
{The user shall make desired changes} 826 826 {The user shall make desired changes}
\item 827 827 \item
{The user shall click `Save Changes'} 828 828 {The user shall click `Save Changes'}
\item 829 829 \item
{The client shall generate a PATCH request for a new flashcard in CardGridController.js 830 830 {The client shall generate a PATCH request for a new flashcard in CardGridController.js
and send it to the server at /api/flashcards/} 831 831 and send it to the server at /api/flashcards/}
\item 832 832 \item
{If the user changed only the blanks of the cards, the server shall 833 833 {If the user changed only the blanks of the cards, the server shall
create a new FlashcardMask object and update the appropriate 834 834 create a new FlashcardMask object and update the appropriate
UserFlashcard object with a reference to it.} 835 835 UserFlashcard object with a reference to it.}
\item 836 836 \item
{If the user changed the text of the card, the server will instead:} 837 837 {If the user changed the text of the card, the server will instead:}
838 838
\begin{enumerate} 839 839 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 840 840 \itemsep1pt\parskip0pt\parsep0pt
\item 841 841 \item
{Create a new flashcard for the section} 842 842 {Create a new flashcard for the section}
\item 843 843 \item
{Push it to the feed} 844 844 {Push it to the feed}
\item 845 845 \item
{Add it to the user's deck} 846 846 {Add it to the user's deck}
\item 847 847 \item
{Hide the old card from the user} 848 848 {Hide the old card from the user}
\item 849 849 \item
{Return the new card to the user} 850 850 {Return the new card to the user}
\end{enumerate} 851 851 \end{enumerate}
\end{enumerate} 852 852 \end{enumerate}
\end{description} 853 853 \end{description}
{} 854 854 {}
855 855
\newpage 856 856 \newpage
857 857
{} 858 858 {}
859 859
\subsection{[F3] Pull Flashcard} 860 860 \subsection{[F3] Pull Flashcard}
\begin{description} 861 861 \begin{description}
\item[Description]{The User shall be able to add flash cards to their own 862 862 \item[Description]{The User shall be able to add flash cards to their own
deck from the Live Feed. } 863 863 deck from the Live Feed. }
864 864
\item[Desired Outcome]{The User shall have the flashcard added to their own 865 865 \item[Desired Outcome]{The User shall have the flashcard added to their own
deck } 866 866 deck }
\\ 867 867 \\
\item[User Goals]{The user will be able to review that flashcard. } 868 868 \item[User Goals]{The user will be able to review that flashcard. }
869 869
\item[Primary Actor]{User (student)} 870 870 \item[Primary Actor]{User (student)}
871 871
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 872 872 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashard} 873 873 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashard}
\\ 874 874 \\
\item[Priority Level]{``Must'' } 875 875 \item[Priority Level]{``Must'' }
876 876
\item[Status]{Implemented} 877 877 \item[Status]{Implemented}
878 878
\item[Pre-conditions] 879 879 \item[Pre-conditions]
880 880
\begin{itemize} 881 881 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 882 882 \itemsep1pt\parskip0pt\parsep0pt
\item 883 883 \item
{A flashcard has been created and is in the Live Feed for a class. } 884 884 {A flashcard has been created and is in the Live Feed for a class. }
\item 885 885 \item
{The User is currently viewing the Live Feed for that class.} 886 886 {The User is currently viewing the Live Feed for that class.}
\end{itemize} 887 887 \end{itemize}
888 888
\item[Post-conditions] 889 889 \item[Post-conditions]
890 890
\begin{itemize} 891 891 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 892 892 \itemsep1pt\parskip0pt\parsep0pt
\item 893 893 \item
{User shall have that flashcard added to their deck.} 894 894 {User shall have that flashcard added to their deck.}
\item 895 895 \item
{User can review this flashcard later.} 896 896 {User can review this flashcard later.}
\end{itemize} 897 897 \end{itemize}
898 898
\item[Trigger]{The User wants to save a flashcard for review later.} 899 899 \item[Trigger]{The User wants to save a flashcard for review later.}
900 900
\item[Workflow] 901 901 \item[Workflow]
902 902
\begin{enumerate} 903 903 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 904 904 \itemsep1pt\parskip0pt\parsep0pt
\item 905 905 \item
{The user shall hover over the flashcard he wants to add to his deck and click on the '+' 906 906 {The user shall hover over the flashcard he wants to add to his deck and click on the '+'
icon that appears in the center of the card.} 907 907 icon that appears in the center of the card.}
\item 908 908 \item
{The frontend shall make the pulled Flashcard appear in the user's deck.} 909 909 {The frontend shall make the pulled Flashcard appear in the user's deck.}
\item 910 910 \item
{The frontend shall generate a POST request in FlashcardFactory.js and send it to 911 911 {The frontend shall generate a POST request in FlashcardFactory.js and send it to
/api/flashcards/\textless{}flashcard id\textgreater{}/pull} 912 912 /api/flashcards/\textless{}flashcard id\textgreater{}/pull}
\item 913 913 \item
{The server shall call the FlashcardViewSet.pull to handle the POST request sent by the frontend.} 914 914 {The server shall call the FlashcardViewSet.pull to handle the POST request sent by the frontend.}
\item 915 915 \item
{The FlashcardViewSet.pull method should call the user.pull method in models.py with the flashcard object 916 916 {The FlashcardViewSet.pull method should call the user.pull method in models.py with the flashcard object
to be pulled as an argument} 917 917 to be pulled as an argument}
\item 918 918 \item
{The user.pull method shall create a UserFlashcard object associated with the request's user and the 919 919 {The user.pull method shall create a UserFlashcard object associated with the request's user and the
passed in flashcard object and save it in the database.} 920 920 passed in flashcard object and save it in the database.}
\item 921 921 \item
{The server shall notify connected clients about the new card rating, 922 922 {The server shall notify connected clients about the new card rating,
if any} 923 923 if any}
\item 924 924 \item
{Connected clients will take the new rating into account when next 925 925 {Connected clients will take the new rating into account when next
rearranging the feed.} 926 926 rearranging the feed.}
\end{enumerate} 927 927 \end{enumerate}
\end{description} 928 928 \end{description}
\newpage 929 929 \newpage
930 930
{} 931 931 {}
932 932
\subsection{[F4] Flag Inappropriate Cards} 933 933 \subsection{[F4] Flag Inappropriate Cards}
934 934
\begin{description} 935 935 \begin{description}
\item[Description]{Cards may be flagged indicating inappropriate content} 936 936 \item[Description]{Cards may be flagged indicating inappropriate content}
937 937
\item[Desired Outcome]{The flashcard's inappropriateness variable is 938 938 \item[Desired Outcome]{The flashcard's inappropriateness variable is
adjusted.} 939 939 adjusted.}
\\ 940 940 \\
\item[User Goals]{To notify the admins if a card is inappropriate and 941 941 \item[User Goals]{To notify the admins if a card is inappropriate and
should not be displayed in the feed.} 942 942 should not be displayed in the feed.}
943 943
\item[Primary Actor]{User (Student)} 944 944 \item[Primary Actor]{User (Student)}
945 945
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 946 946 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 947 947 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 948 948 \\
\item[Priority Level]{``Should''} 949 949 \item[Priority Level]{``Should''}
950 950
\item[Status]{Implemented} 951 951 \item[Status]{Implemented}
952 952
\item[Pre-conditions] 953 953 \item[Pre-conditions]
954 954
\begin{itemize} 955 955 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 956 956 \itemsep1pt\parskip0pt\parsep0pt
\item 957 957 \item
{The user is enrolled in a class} 958 958 {The user is enrolled in a class}
\item 959 959 \item
{The flashcard has been created.} 960 960 {The flashcard has been created.}
\item 961 961 \item
{The flashcard is viewable in feed.} 962 962 {The flashcard is viewable in feed.}
\item 963 963 \item
{The user has clicked the red 'eye' icon on the flashcard which is the "Hide Card" button.} 964 964 {The user has clicked the red 'eye' icon on the flashcard which is the "Hide Card" button.}
\end{itemize} 965 965 \end{itemize}
966 966
\item[Post-conditions] 967 967 \item[Post-conditions]
968 968
\begin{itemize} 969 969 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 970 970 \itemsep1pt\parskip0pt\parsep0pt
\item 971 971 \item
{Flashcard is hidden from user.} 972 972 {Flashcard is hidden from user.}
\item 973 973 \item
{The flashcard is marked as being inappropriate.} 974 974 {The flashcard is marked as being inappropriate.}
\end{itemize} 975 975 \end{itemize}
976 976
\item[Trigger]{The User does not like the particular flashcard.} 977 977 \item[Trigger]{The User does not like the particular flashcard.}
978 978
\item[Workflow] 979 979 \item[Workflow]
980 980
\begin{enumerate} 981 981 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 982 982 \itemsep1pt\parskip0pt\parsep0pt
\item 983 983 \item
{The frontend displays a toast that offers the user the report text.} 984 984 {The frontend displays a toast that offers the user the report text.}
\item 985 985 \item
{The user clicks the ``Report'' text on the flashcard.} 986 986 {The user clicks the ``Report'' text on the flashcard.}
\item 987 987 \item
{The frontend shall hide the flashcard from the user in FlashcardFactory.js.} 988 988 {The frontend shall hide the flashcard from the user in FlashcardFactory.js.}
\item 989 989 \item
{The frontend shall generate a POST request in Flashcard.report in FlashcardFactory.js 990 990 {The frontend shall generate a POST request in Flashcard.report in FlashcardFactory.js
and send it to /api/flashcards/\textless{}flashcard id \textgreater{}/report} 991 991 and send it to /api/flashcards/\textless{}flashcard id \textgreater{}/report}
\item 992 992 \item
{The backend shall check if the user already hid the flashcard in views.py function report.} 993 993 {The backend shall check if the user already hid the flashcard in views.py function report.}
\item 994 994 \item
{The backend shall hide the flashcard in models.py in class FlashcardHide. } 995 995 {The backend shall hide the flashcard in models.py in class FlashcardHide. }
\end{enumerate} 996 996 \end{enumerate}
\end{description} 997 997 \end{description}
{} 998 998 {}
999 999
{} 1000 1000 {}
1001 1001
\newpage 1002 1002 \newpage
1003 1003
{} 1004 1004 {}
1005 1005
\subsection{[F5] Filter Flashcards } 1006 1006 \subsection{[F5] Filter Flashcards }
1007 1007
\begin{description} 1008 1008 \begin{description}
\item[Description]{The user is able to filter for flashcards by material date and text.} 1009 1009 \item[Description]{The user is able to filter for flashcards by material date and text.}
1010 1010
\item[Desired Outcome]{The user shall see flashcards based on the filter 1011 1011 \item[Desired Outcome]{The user shall see flashcards based on the filter
options: the material date and the text of the card.} 1012 1012 options: the material date and the text of the card.}
1013 1013
{User Goals:}{The user can find what he/she is specifically looking 1014 1014 {User Goals:}{The user can find what he/she is specifically looking
for.} 1015 1015 for.}
1016 1016
\item[Primary Actor]{User} 1017 1017 \item[Primary Actor]{User}
1018 1018
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1019 1019 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull 1020 1020 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
Flashcard} 1021 1021 Flashcard}
\\ 1022 1022 \\
\item[Priority Level]{''Should''} 1023 1023 \item[Priority Level]{''Should''}
1024 1024
\item[Status]{Implemented } 1025 1025 \item[Status]{Implemented }
1026 1026
\item[Pre-conditions] 1027 1027 \item[Pre-conditions]
1028 1028
\begin{itemize} 1029 1029 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1030 1030 \itemsep1pt\parskip0pt\parsep0pt
\item 1031 1031 \item
{The user has added a class.} 1032 1032 {The user has added a class.}
\item 1033 1033 \item
{The class in question contains non-zero number of flashcards.} 1034 1034 {The class in question contains non-zero number of flashcards.}
\end{itemize} 1035 1035 \end{itemize}
1036 1036
\item[Post-conditions]{} 1037 1037 \item[Post-conditions]{}
1038 1038
\begin{itemize} 1039 1039 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1040 1040 \itemsep1pt\parskip0pt\parsep0pt
\item 1041 1041 \item
{The user only sees the flashcards that match his filter criterion.} 1042 1042 {The user only sees the flashcards that match his filter criterion.}
\end{itemize} 1043 1043 \end{itemize}
1044 1044
\item[Trigger]{The user wants to only see cards for a specific date range or with a specific substring in their text.} 1045 1045 \item[Trigger]{The user wants to only see cards for a specific date range or with a specific substring in their text.}
1046 1046
\item[Workflow] 1047 1047 \item[Workflow]
1048 1048
\begin{enumerate} 1049 1049 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1050 1050 \itemsep1pt\parskip0pt\parsep0pt
\item 1051 1051 \item
{The frontend shall render the page described in study.html using CardListController.js.} 1052 1052 {The frontend shall render the page described in study.html using CardListController.js.}
\item 1053 1053 \item
{The user shall select the weeks that the filtered cards should belong to.} 1054 1054 {The user shall select the weeks that the filtered cards should belong to.}
\item 1055 1055 \item
{The user shall type in the appropriate search filter in the text input box on the top right of the screen.} 1056 1056 {The user shall type in the appropriate search filter in the text input box on the top right of the screen.}
\item 1057 1057 \item
{The frontend generates a POST request with the flashcard dates and the flashcard text filter as 1058 1058 {The frontend generates a POST request with the flashcard dates and the flashcard text filter as
parameteres and sends it to /api/study.} 1059 1059 parameteres and sends it to /api/study.}
\item 1060 1060 \item
{The system displays only the cards that match the filter criteria specified by the user.} 1061 1061 {The system displays only the cards that match the filter criteria specified by the user.}
1062 1062
\end{enumerate} 1063 1063 \end{enumerate}
\end{description} 1064 1064 \end{description}
{} 1065 1065 {}
1066 1066
\newpage 1067 1067 \newpage
1068 1068
{} 1069 1069 {}
1070 1070
\subsection{[F6] Blank Out Words in Flashcard} 1071 1071 \subsection{[F6] Blank Out Words in Flashcard}
1072 1072
\begin{description} 1073 1073 \begin{description}
\item[Description]{The User shall be able to blank out keywords in any 1074 1074 \item[Description]{The User shall be able to blank out keywords in any
flashcard in his deck. } 1075 1075 flashcard in his deck. }
1076 1076
\item[Desired Outcome]{The blanked out words in the flashcard notify the 1077 1077 \item[Desired Outcome]{The blanked out words in the flashcard notify the
System that they are keywords. } 1078 1078 System that they are keywords. }
\\ 1079 1079 \\
\item[User Goals]{The User shall mark some words as keywords so the System 1080 1080 \item[User Goals]{The User shall mark some words as keywords so the System
may later quiz theirself by blanking out the keywords and having the 1081 1081 may later quiz theirself by blanking out the keywords and having the
User guess what they are.} 1082 1082 User guess what they are.}
1083 1083
{Primary Actor: }{User (student)} 1084 1084 {Primary Actor: }{User (student)}
1085 1085
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1086 1086 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1087 1087 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1088 1088 \\
\item[Priority Level]{``Must''} 1089 1089 \item[Priority Level]{``Must''}
1090 1090
\item[Status]{Implemented.} 1091 1091 \item[Status]{Implemented.}
1092 1092
\item[Pre-conditions] 1093 1093 \item[Pre-conditions]
1094 1094
\begin{itemize} 1095 1095 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1096 1096 \itemsep1pt\parskip0pt\parsep0pt
\item 1097 1097 \item
{The User has an account and is logged in.} 1098 1098 {The User has an account and is logged in.}
\item 1099 1099 \item
{The User shall be on the Live Feed for the class.} 1100 1100 {The User shall be on the Live Feed for the class.}
\item 1101 1101 \item
{The User has clicked the 'c' hotkey or the 'plus' button to start making a card.} 1102 1102 {The User has clicked the 'c' hotkey or the 'plus' button to start making a card.}
\item 1103 1103 \item
{The User shall type in information relevant to their class.} 1104 1104 {The User shall type in information relevant to their class.}
\end{itemize} 1105 1105 \end{itemize}
1106 1106
{Post-conditions: } 1107 1107 {Post-conditions: }
1108 1108
\begin{itemize} 1109 1109 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1110 1110 \itemsep1pt\parskip0pt\parsep0pt
\item 1111 1111 \item
{The blanked out words in the flashcard are marked as keywords.} 1112 1112 {The blanked out words in the flashcard are marked as keywords.}
\item 1113 1113 \item
{The System shall blank out the keywords and let the User guess what 1114 1114 {The System shall blank out the keywords and let the User guess what
they are when it presents the flashcard to the User for reviewing.} 1115 1115 they are when it presents the flashcard to the User for reviewing.}
\end{itemize} 1116 1116 \end{itemize}
1117 1117
\item[Trigger]{The User wants to make a flashcard and be quizzed on parts of the flashcard while they study.} 1118 1118 \item[Trigger]{The User wants to make a flashcard and be quizzed on parts of the flashcard while they study.}
1119 1119
\item[Workflow] 1120 1120 \item[Workflow]
1121 1121
\begin{enumerate} 1122 1122 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1123 1123 \itemsep1pt\parskip0pt\parsep0pt
\item 1124 1124 \item
{The User shall highlight the words that he wishes to blank out.} 1125 1125 {The User shall highlight the words that he wishes to blank out.}
\item 1126 1126 \item
{The frontend shall enclose the selected text in \textless{}b\textgreater{} tags to alter its appearance.} 1127 1127 {The frontend shall enclose the selected text in \textless{}b\textgreater{} tags to alter its appearance.}
\item 1128 1128 \item
{The User shall click the 'Contribute' button.} 1129 1129 {The User shall click the 'Contribute' button.}
\item 1130 1130 \item
{The frontend shall convert the blanked portion of the text into a list of offsets to be 1131 1131 {The frontend shall convert the blanked portion of the text into a list of offsets to be
sent to the backend in FeedController.js.} 1132 1132 sent to the backend in FeedController.js.}
\item 1133 1133 \item
{The backend shall mark those words by updating the field mask for 1134 1134 {The backend shall mark those words by updating the field mask for
that userflashcard object in views.py in function create. } 1135 1135 that userflashcard object in views.py in function create. }
\item 1136 1136 \item
{The backend shall save the new mask in models.py.} 1137 1137 {The backend shall save the new mask in models.py.}
\end{enumerate} 1138 1138 \end{enumerate}
1139 1139
{Alternative Workflows:} 1140 1140 \item [Alternate Workflow]
1141 1141
\begin{enumerate} 1142 1142 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1143 1143 \itemsep1pt\parskip0pt\parsep0pt
\item 1144 1144 \item
{Precondition: The User has clicked the edit flashcard button instead of creating a new card.} 1145 1145 {Precondition: The User has clicked the edit flashcard button instead of creating a new card.}
\item 1146 1146 \item
{The User shall highlight selection text and click either ctrl-b or 'Blank Selected Text'.} 1147 1147 {The User shall highlight selection text and click either ctrl-b or 'Blank Selected Text'.}
\item 1148 1148 \item
{The frontend shall enclose the selected text in \textless{}b\textgreater{} tags to alter its appearance.} 1149 1149 {The frontend shall enclose the selected text in \textless{}b\textgreater{} tags to alter its appearance.}
\item 1150 1150 \item
{The frontend shall convert the blanked portion of the text into a list of offsets to be 1151 1151 {The frontend shall convert the blanked portion of the text into a list of offsets to be
sent to the backend in CardGridController.js.} 1152 1152 sent to the backend in CardGridController.js.}
\item 1153 1153 \item
{The backend shall mark those words by updating the field mask for 1154 1154 {The backend shall mark those words by updating the field mask for
that userflashcard object in views.py in function create. } 1155 1155 that userflashcard object in views.py in function create. }
\item 1156 1156 \item
{The backend shall save those in models.py.} 1157 1157 {The backend shall save those in models.py.}
\end{enumerate} 1158 1158 \end{enumerate}
\end{description} 1159 1159 \end{description}
{} 1160 1160 {}
1161 1161
\newpage 1162 1162 \newpage
1163 1163
{} 1164 1164 {}
1165 1165
\subsection{[F7] Fix Flashcard} 1166 1166 \subsection{[F7] Fix Flashcard}
1167 1167
\begin{description} 1168 1168 \begin{description}
\item[Description]{The User shall be able to alter a flashcard he/she made 1169 1169 \item[Description]{The User shall be able to alter a flashcard he/she made originally.}
originally and not have to make a new copy of it.} 1170
1171 1170
\item[Desired Outcome]{The User shall alter one flashcard and that 1172 1171 \item[Desired Outcome]{The system changes the flashcard in the user's deck so that it
alteration will be shown to all users of that flashcard} 1173 1172 doesn't affect any other users who added the previous version of the flashcard to their decks.}
\\ 1174 1173 \\
\item[User Goals]{The user shall make the flashcard say something different 1175 1174 \item[User Goals]{The user shall either change the text or the blanks of the flashcard.}
than it did originally.} 1176
1177 1175
\item[Primary Actor]{User (student) } 1178 1176 \item[Primary Actor]{User (student) }
1179 1177
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1180 1178 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1181 1179 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1182 1180 \\
\item[Priority Level]{Must} 1183 1181 \item[Priority Level]{Must}
1184 1182
\item[Status]{Implemented} 1185 1183 \item[Status]{Implemented}
1186 1184
\item[Pre-conditions] 1187 1185 \item[Pre-conditions]
1188 1186
\begin{itemize} 1189 1187 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1190 1188 \itemsep1pt\parskip0pt\parsep0pt
\item 1191 1189 \item
{User has created the flashcard} 1192 1190 {The user has created the flashcard}
1191 \item
1192 {The user is either in the feed view or the deck view of a class and can see the
1193 flashcard that he wishes to fix.}
\end{itemize} 1193 1194 \end{itemize}
1194 1195
\item[Post-conditions]{} 1195 1196 \item[Post-conditions]{}
1196 1197
\begin{itemize} 1197 1198 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1198 1199 \itemsep1pt\parskip0pt\parsep0pt
\item 1199 1200 \item
{The user shall see their alteration for that flashcard} 1200 1201 {The flashcard in the user's deck gets updated to reflect the changes made by the user.}
\item 1201
{Other users will be notified of the alteration} 1202
\end{itemize} 1203 1202 \end{itemize}
1204 1203
\item[Trigger]{User (creator of original card) has clicked on the button 1205 1204 \item[Trigger]{User (creator of original card) has clicked on the button
``Edit''} 1206 1205 blue pencil icon at the bottom left of the flashcard.}
1207 1206
\item[Workflow] 1208 1207 \item[Workflow]
1209 1208
\begin{enumerate} 1210 1209 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1211 1210 \itemsep1pt\parskip0pt\parsep0pt
\item 1212 1211 \item
{User shall select one of the Flashcards they authored.} 1213 1212 {User shall hover over one of the Flashcards they authored.}
\item 1214 1213 \item
{User shall select ``Edit'' button on the flashcard.} 1215 1214 {User shall click on the blue pencil icon at the bottom of the flashcard.}
\item 1216 1215 \item
{Client shall display an ``Edit Flashcard'' view.} 1217 1216 {The frontend shall display a dialog box to edit the flashcard.}
\item 1218 1217 \item
{The Flashcard will display editable fields/areas.} 1219 1218 {The User shall change the text and the blanks of the flashcards appropriately.}
\item 1220 1219 \item
{The User shall input any changes to the Flashcard.} 1221 1220 {The User shall click on the ``Save Changes'' button.}
\item 1222 1221 \item
{The User shall select the ``Done Editing'' button.} 1223 1222 {The frontend shall convert the blanked portion of the text into a list of offsets to be
1223 sent to the backend in CardGridController.js.}
\item 1224 1224 \item
{The Client shall close the ``Edit Flashcard'' view.} 1225 1225 {The server shall update the flashcards content in FlashcardViewSet.partial_update in views.py.}
\item 1226 1226 \item
{The server shall update the Flashcard's content.} 1227 1227 {The backend makes sure that no other user has the card in question in his/her deck.}
\item 1228 1228 \item
{Client shall notify users with the Flashcard that the Flashcard has 1229 1229 {The backend makes the appropriate changes to the card and saves them.}
been edited, allowing the other users to keep or to discard the 1230
changes.} 1231
\end{enumerate} 1232 1230 \end{enumerate}
1231 \item[Alternate Workflow]
1232 \begin{enumerate}
1233 \itemsep1pt\parskip0pt\parsep0pt
1234 \item
1235 {The backend finds that other users have added the card that is being edited.}
1236 \item
1237 {The backend shall create a new card with the passed in changes applied and add it to the user's deck
1238 after removing the older card from the user's deck.}
\end{description} 1233 1239 \end{description}
{} 1234 1240 {}
1235 1241
{} 1236 1242 {}
1237 1243
{} 1238 1244 {}
1239 1245
\newpage 1240 1246 \newpage
1241 1247
{} 1242 1248 {}
1243 1249
\subsection{[F8] Hide Cards} 1244 1250 \subsection{[F8] Hide Cards}
1245 1251
\begin{description} 1246 1252 \begin{description}
\item[Description]{The user shall be able to hide cards from feed} 1247 1253 \item[Description]{The user shall be able to hide cards from feed}
1248 1254
\item[Desired Outcome]{The card is no longer visible to the user} 1249 1255 \item[Desired Outcome]{The card is no longer visible to the user}
\\ 1250 1256 \\
\item[User Goals]{The card has been looked at and should be hidden to 1251 1257 \item[User Goals]{The card has been looked at and should be hidden to
reduce screen clutter} 1252 1258 reduce screen clutter}
1253 1259
{Primary Actor: }{User (Student)} 1254 1260 {Primary Actor: }{User (Student)}
1255 1261
\item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User 1256 1262 \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1257 1263 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1258 1264 \\
\item[Priority Level]{``Should''} 1259 1265 \item[Priority Level]{``Should''}
1260 1266
{Status:}{Implemented} 1261 1267 {Status:}{Implemented}
1262 1268
\item[Pre-conditions]{Flashcard is created, flashcard is viewable by user.} 1263 1269 \item[Pre-conditions]{Flashcard is created, flashcard is viewable by user.}
1264 1270
\item[Post-conditions]{Flashcard is not viewable by user} 1265 1271 \item[Post-conditions]{Flashcard is not viewable by user}
1266 1272
\item[Trigger]{The User no longer wants to see a card in their feed and deck.} 1267 1273 \item[Trigger]{The User no longer wants to see a card in their feed and deck.}
1268 1274
\item[Workflow] 1269 1275 \item[Workflow]
1270 1276
\begin{enumerate} 1271 1277 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1272 1278 \itemsep1pt\parskip0pt\parsep0pt
\item 1273 1279 \item
{The User chooses a class from the drop down menu.} 1274 1280 {The User chooses a class from the drop down menu.}
\item 1275 1281 \item
{The frontend renders the Live Feed for the selected class from feed.html.} 1276 1282 {The frontend renders the Live Feed for the selected class from feed.html.}
\item 1277 1283 \item
{The User sees a card they want to hide.} 1278 1284 {The User sees a card they want to hide.}
\item 1279 1285 \item
{The User shall press the ``Hide Flashcard'' button on the card to be 1280 1286 {The User shall press the ``Hide Flashcard'' button on the card to be
hidden.} 1281 1287 hidden.}
\item 1282 1288 \item
{The frontend shall make a request to the backend from FeedController.js.} 1283 1289 {The frontend shall make a request to the backend from FeedController.js.}
\item 1284 1290 \item
{The backend shall check if the User has already hidden that card in views.py.} 1285 1291 {The backend shall check if the User has already hidden that card in views.py.}
\item 1286 1292 \item
{The backend shall change the falshcard to hidden in the models.py.} 1287 1293 {The backend shall change the falshcard to hidden in the models.py.}
\item 1288 1294 \item
{The frontend shall no longer show that card when the feed is rendered.} 1289 1295 {The frontend shall no longer show that card when the feed is rendered.}
\end{enumerate} 1290 1296 \end{enumerate}
1291 1297
\end{description} 1292 1298 \end{description}
1293 1299
\newpage 1294 1300 \newpage
1295 1301
{} 1296 1302 {}
1297 1303
\subsection{[F9] View a Feed} 1298 1304 \subsection{[F9] View a Feed}
1299 1305
\begin{description} 1300 1306 \begin{description}
\item[Description]{The User shall be able to view Live Feeds for different 1301 1307 \item[Description]{The User shall be able to view Live Feeds for different
classes} 1302 1308 classes}
1303 1309
\item[Desired Outcome]{The system shall only show the user Live Feeds for 1304 1310 \item[Desired Outcome]{The system shall only show the user Live Feeds for
specific classes. } 1305 1311 specific classes. }
\\ 1306 1312 \\
\item[User Goals]{The User will see only one Live Feed at a time. } 1307 1313 \item[User Goals]{The User will see only one Live Feed at a time. }
1308 1314
\item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User 1309 1315 \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 1310 1316 Login, {[}A3{]} Add a Class}
\\ 1311 1317 \\
\item[Priority Level]{``Must''} 1312 1318 \item[Priority Level]{``Must''}
1313 1319
{Status:}{Implemented} 1314 1320 {Status:}{Implemented}
1315 1321
\item[Pre-conditions]{User has added a class.} 1316 1322 \item[Pre-conditions]{User has added a class.}
1317 1323
\item[Post-conditions]{User shall see the Live Feed for that class} 1318 1324 \item[Post-conditions]{User shall see the Live Feed for that class}
1319 1325
\item[Trigger]{User shall select a class} 1320 1326 \item[Trigger]{User shall select a class}
1321 1327
\item[Workflow] 1322 1328 \item[Workflow]
1323 1329
\begin{enumerate} 1324 1330 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1325 1331 \itemsep1pt\parskip0pt\parsep0pt
\item 1326 1332 \item
{The User logs into their account.} 1327 1333 {The User logs into their account.}
\item 1328 1334 \item
{The System verifies the User's credentials and saves their session.} 1329 1335 {The System verifies the User's credentials and saves their session.}
\item 1330 1336 \item
{The User is at their dashboard.} 1331 1337 {The User is at their dashboard.}
\item 1332 1338 \item
{The Client shows the User's dashboard.} 1333 1339 {The Client shows the User's dashboard.}
\item 1334 1340 \item
{The User selects a class from their dashboard.} 1335 1341 {The User selects a class from their dashboard.}
\item 1336 1342 \item
{The Client displays the Live Feed for the class.} 1337 1343 {The Client displays the Live Feed for the class.}
\end{enumerate} 1338 1344 \end{enumerate}
1339 1345
\end{description} 1340 1346 \end{description}
\newpage 1341 1347 \newpage
1342 1348
{} 1343 1349 {}
\section{Decks} 1344 1350 \section{Decks}
1345 1351
\subsection{[D1] Remove a card from a deck} 1346 1352 \subsection{[D1] Remove a card from a deck}
1347 1353
\begin{description} 1348 1354 \begin{description}
\item[Description]{The user can remove flashcards from their deck.} 1349 1355 \item[Description]{The user can remove flashcards from their deck.}
1350 1356
\item[Desired Outcome]{The user will not be notified about that card. } 1351 1357 \item[Desired Outcome]{The user will not be notified about that card. }
\\ 1352 1358 \\
\item[User Goals]{To only review cards that the user wants to review. } 1353 1359 \item[User Goals]{To only review cards that the user wants to review. }
1354 1360
\item[Primary Actor]{User (student)} 1355 1361 \item[Primary Actor]{User (student)}
1356 1362
\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck 1357 1363 \item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck
{[}F1{]}, Make a Flashcard {[}F3{]}} 1358 1364 {[}F1{]}, Make a Flashcard {[}F3{]}}
\\ 1359 1365 \\
\item[Priority Level]{``Must''} 1360 1366 \item[Priority Level]{``Must''}
1361 1367
\item[Status]{Implemented} 1362 1368 \item[Status]{Implemented}
1363 1369
\item[Pre-conditions] 1364 1370 \item[Pre-conditions]
1365 1371
\begin{itemize} 1366 1372 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1367 1373 \itemsep1pt\parskip0pt\parsep0pt
\item 1368 1374 \item
{The User has an account with the application} 1369 1375 {The User has an account with the application}
\item 1370 1376 \item
{The User is logged in} 1371 1377 {The User is logged in}
\end{itemize} 1372 1378 \end{itemize}
1373 1379
\item[Post-conditions] 1374 1380 \item[Post-conditions]
1375 1381
\begin{itemize} 1376 1382 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1377 1383 \itemsep1pt\parskip0pt\parsep0pt
\item 1378 1384 \item
{Desired cards are hidden to the user.} 1379 1385 {Desired cards are hidden to the user.}
\end{itemize} 1380 1386 \end{itemize}
1381 1387
\item[Trigger]{The User no longer wishes to be able to study a card. } 1382 1388 \item[Trigger]{The User no longer wishes to be able to study a card. }
1383 1389
\item[Workflow] 1384 1390 \item[Workflow]
1385 1391
\begin{enumerate} 1386 1392 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1387 1393 \itemsep1pt\parskip0pt\parsep0pt
\item 1388 1394 \item
{The Client shows the user the dashboard.} 1389 1395 {The Client shows the user the dashboard.}
\item 1390 1396 \item
{The User shall select the appropriate class.} 1391 1397 {The User shall select the appropriate class.}
\item 1392 1398 \item
{The System checks if the class is in session.} 1393 1399 {The System checks if the class is in session.}
\item 1394 1400 \item
{The User shall select deck view.} 1395 1401 {The User shall select deck view.}
\item 1396 1402 \item
{The Client shall route the user to the deck view.} 1397 1403 {The Client shall route the user to the deck view.}
\item 1398 1404 \item
{The User clicks a flashcard's remove button.} 1399 1405 {The User clicks a flashcard's remove button.}
\item 1400 1406 \item
{The Client shall send a DELETE request to the server}{}{at 1401 1407 {The Client shall send a DELETE request to the server}{}{at
/api/flashcard/\textless{}flashcard ID\textgreater{}/remove} 1402 1408 /api/flashcard/\textless{}flashcard ID\textgreater{}/remove}
\item 1403 1409 \item
{The Server removes the flashcard from the User's Deck.} 1404 1410 {The Server removes the flashcard from the User's Deck.}
\item 1405 1411 \item
{The Server updates the flashcard's position in the Live Feed.} 1406 1412 {The Server updates the flashcard's position in the Live Feed.}
\item 1407 1413 \item
{The Client updates the User's Deck.} 1408 1414 {The Client updates the User's Deck.}
\end{enumerate} 1409 1415 \end{enumerate}
1410 1416
{} 1411 1417 {}
1412 1418
{Alternate Workflow:} 1413 1419 \item [Alternate Workflow]
1414 1420
\begin{enumerate} 1415 1421 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1416 1422 \itemsep1pt\parskip0pt\parsep0pt
\item 1417 1423 \item
{The Client shows the user the dashboard.} 1418 1424 {The Client shows the user the dashboard.}
\item 1419 1425 \item
{The User shall select the appropriate class.} 1420 1426 {The User shall select the appropriate class.}
\item 1421 1427 \item
{The System checks if the class is }{not}{in session.} 1422 1428 {The System checks if the class is }{not}{in session.}
\item 1423 1429 \item
{The Client shall the user to the deck view.} 1424 1430 {The Client shall the user to the deck view.}
\item 1425 1431 \item
{The User clicks a flashcard's remove button.} 1426 1432 {The User clicks a flashcard's remove button.}
\item 1427 1433 \item
{The Client shall send a DELETE request to the server}{}{at 1428 1434 {The Client shall send a DELETE request to the server}{}{at
/api/flashcard/\textless{}flashcard ID\textgreater{}/remove} 1429 1435 /api/flashcard/\textless{}flashcard ID\textgreater{}/remove}
\item 1430 1436 \item
{The Server removes the flashcard from the User's Deck.} 1431 1437 {The Server removes the flashcard from the User's Deck.}
\item 1432 1438 \item
{The Server updates the flashcard's position in the Live Feed.} 1433 1439 {The Server updates the flashcard's position in the Live Feed.}
\item 1434 1440 \item
{The Client updates the User's Deck.} 1435 1441 {The Client updates the User's Deck.}
\end{enumerate} 1436 1442 \end{enumerate}
\end{description} 1437 1443 \end{description}
TestCases.tex View file @ d4644ca
\documentclass[letterpaper]{scrartcl} % or whatever 1 1 \documentclass[letterpaper]{scrartcl} % or whatever
\usepackage{tgpagella} 2 2 \usepackage{tgpagella}
\setkomafont{disposition}{\normalfont\bfseries} 3 3 \setkomafont{disposition}{\normalfont\bfseries}
%\usepackage[markuppercase]{scrpage2} 4 4 %\usepackage[markuppercase]{scrpage2}
\title{\huge System Test Plan} 5 5 \title{\huge System Test Plan}
\date{\today} 6 6 \date{\today}
\author{\Large Students With A Goal (S.W.A.G.)} 7 7 \author{\Large Students With A Goal (S.W.A.G.)}
\usepackage[pass]{geometry} 8 8 \usepackage[pass]{geometry}
\usepackage{hyperref} 9 9 \usepackage{hyperref}
\usepackage{graphicx} 10 10 \usepackage{graphicx}
\usepackage{enumitem} 11 11 \usepackage{enumitem}
\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf} 12 12 \setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}
\setlistdepth{9} 13 13 \setlistdepth{9}
14 14
\setlist[itemize,1]{label=$\bullet$} 15 15 \setlist[itemize,1]{label=$\bullet$}
\setlist[itemize,2]{label=$\bullet$} 16 16 \setlist[itemize,2]{label=$\bullet$}
\setlist[itemize,3]{label=$\bullet$} 17 17 \setlist[itemize,3]{label=$\bullet$}
\setlist[itemize,4]{label=$\bullet$} 18 18 \setlist[itemize,4]{label=$\bullet$}
\setlist[itemize,5]{label=$\bullet$} 19 19 \setlist[itemize,5]{label=$\bullet$}
\setlist[itemize,6]{label=$\bullet$} 20 20 \setlist[itemize,6]{label=$\bullet$}
\setlist[itemize,7]{label=$\bullet$} 21 21 \setlist[itemize,7]{label=$\bullet$}
\setlist[itemize,8]{label=$\bullet$} 22 22 \setlist[itemize,8]{label=$\bullet$}
\setlist[itemize,9]{label=$\bullet$} 23 23 \setlist[itemize,9]{label=$\bullet$}
\renewlist{itemize}{itemize}{9} 24 24 \renewlist{itemize}{itemize}{9}
\begin{document} 25 25 \begin{document}
\maketitle 26 26 \maketitle
\begin{center} 27 27 \begin{center}
\includegraphics[width=12cm]{../swag_logo.png}\\ 28 28 \includegraphics[width=12cm]{../swag_logo.png}\\
29 29
\begin{tabular}{l r} 30 30 \begin{tabular}{l r}
Melody Jeng & System Architect \\ 31 31 Melody Jeng & System Architect \\
Arno Gau & Senior System Analyst \\ 32 32 Arno Gau & Senior System Analyst \\
Rachel Lee & Software Development Lead \\ 33 33 Rachel Lee & Software Development Lead \\
Laura Hawkins & Project Manager \\ 34 34 Laura Hawkins & Project Manager \\
Rohan Rangray & Algorithms Specialist\\ 35 35 Rohan Rangray & Algorithms Specialist\\
Andrew Buss & Database Specialist \\ 36 36 Andrew Buss & Database Specialist \\
Nam Phuong Tran & Quality Assurance Lead \\ 37 37 Nam Phuong Tran & Quality Assurance Lead \\
Chung Kang Wang & Business Analyst\\ 38 38 Chung Kang Wang & Business Analyst\\
Masud Rahman & User Interface Specialist\\ 39 39 Masud Rahman & User Interface Specialist\\
Kevin Mach & User Interface Specialist\\ 40 40 Kevin Mach & User Interface Specialist\\
\end{tabular} 41 41 \end{tabular}
\end{center} 42 42 \end{center}
\newpage 43 43 \newpage
\tableofcontents 44 44 \tableofcontents
\newpage 45 45 \newpage
46 46
\section{Testing Notes} 47 47 \section{Testing Notes}
\subsection{Testing Accounts} 48 48 \subsection{Testing Accounts}
UserX\\ 49 49 UserX\\
- email: UserX@flashy.cards\\ 50 50 - email: UserX@flashy.cards\\
- password: mynameisuserx 51 51 - password: mynameisuserx
\\ 52 52 \\
UserY\\ 53 53 UserY\\
- email: UserY@flashy.cards\\ 54 54 - email: UserY@flashy.cards\\
- password: mynameisusery 55 55 - password: mynameisusery
56 56
\subsection{Fixtures} 57 57 \subsection{Fixtures}
Fixtures are provided to reset the database to a known state before running each test case. This isolates the effects of each test case and simplifies resolution of preconditions. Each test case specifies a test fixture which may be applied by running the command \texttt{scripts/apply-test-fixture.sh <fixture name>} in the root of the backend directory. Once a fixture has been applied, reload the page, log back in (if required by the test case) and continue running the test case. 58 58 Fixtures are provided to reset the database to a known state before running each test case. This isolates the effects of each test case and simplifies resolution of preconditions. Each test case specifies a test fixture which may be applied by running the command \texttt{scripts/apply-test-fixture.sh <fixture name>} in the root of the backend directory. Once a fixture has been applied, reload the page, log back in (if required by the test case) and continue running the test case.
\subsection{Testing Multiple Users} 59 59 \subsection{Testing Multiple Users}
Some test cases relating to real-time functionality require two users simultaneously logged into the the application. This requires two separate browser sessions. Refer to browser documentation for this. 60 60 Some test cases relating to real-time functionality require two users simultaneously logged into the the application. This requires two separate browser sessions. Refer to browser documentation for this.
\subsection{Supported Browser} 61 61 \subsection{Supported Browser}
Flashy officially supports Chrome version 42 on Windows and Linux. Frontend functionality may be degraded on other browsers. 62 62 Flashy officially supports Chrome version 42 on Windows and Linux. Frontend functionality may be degraded on other browsers.
63 63
\subsection{Sent Emails in Development} 64 64 \subsection{Sent Emails in Development}
As noted in the backend README, when run as a local development server for testing, Flashy does not actually send email except in a production environment. Sending email requires an AWS SES key that we do not want to bundle with our application's source. Instead they are printed out to the server console. When any reference is made to an email being sent, check the console. Example: 65 65 As noted in the backend README, when run as a local development server for testing, Flashy does not actually send email except in a production environment. Sending email requires an AWS SES key that we do not want to bundle with our application's source. Instead they are printed out to the server console. When any reference is made to an email being sent, check the console. Example:
66 66
\includegraphics[width=4in]{../doc_screenshots/console_backend.png} 67 67 \includegraphics[width=4in]{../doc_screenshots/console_backend.png}
68 68
\newpage 69 69 \newpage
70 70
71 71
\section{Accounts} 72 72 \section{Accounts}
73 73
\subsection{[A1] User Registration} 74 74 \subsection{[A1] User Registration}
\begin{description}[style=multiline,leftmargin=3cm] 75 75 \begin{description}[style=multiline,leftmargin=3cm]
76 76
\item[Description:]{This test case outlines the presentation layering step 77 77 \item[Description:]{This test case outlines the presentation layering step
process of a user registering for an account with our application.} 78 78 process of a user registering for an account with our application.}
79 79
\item[Desired Outcome:]{An account will be created for the User from the 80 80 \item[Desired Outcome:]{An account will be created for the User from the
specified username, password, email. The User will be able to log into 81 81 specified username, password, email. The User will be able to log into
the aforementioned account.} 82 82 the aforementioned account.}
83 83
\item[User Goals:]{The User shall have an account to participate in the 84 84 \item[User Goals:]{The User shall have an account to participate in the
website's activities.} 85 85 website's activities.}
86 86
\item[Dependency Use Cases:]{None} 87 87 \item[Dependency Use Cases:]{None}
\\ 88 88 \\
89 89
\item[Priority Level:]{``Must''} 90 90 \item[Priority Level:]{``Must''}
91 91
\item[Status:]{Implemented} 92 92 \item[Status:]{Implemented}
93 93
\item[Preconditions:] 94 94 \item[Preconditions:]
\begin{itemize} 95 95 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 96 96 \itemsep1pt\parskip0pt\parsep0pt
\item 97 97 \item
{None} 98 98 {None}
\end{itemize} 99 99 \end{itemize}
100 100
\item[Postconditions:] 101 101 \item[Postconditions:]
\begin{itemize} 102 102 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 103 103 \itemsep1pt\parskip0pt\parsep0pt
\item 104 104 \item
{The User has an account registered with the system.} 105 105 {The User has an account registered with the system.}
\end{itemize} 106 106 \end{itemize}
107 107
\item[Trigger:]{UserX wants to start creating flashcards for a class.} 108 108 \item[Trigger:]{UserX wants to start creating flashcards for a class.}
109 109
\item[Workflow:] 110 110 \item[Workflow:]
\begin{enumerate} 111 111 \begin{enumerate}
\item 112 112 \item
{UserX shall click the ``Sign Up'' button.} 113 113 {UserX shall click the ``Sign Up'' button.}
\item 114 114 \item
{The System shall display a registration form.} 115 115 {The System shall display a registration form.}
\item 116 116 \item
{UserX shall fill in the form with email \mbox{UserX@flashy.cards} and password 117 117 {UserX shall fill in the form with email \mbox{UserX@flashy.cards} and password
\mbox{``mynameisuserx''}.} 118 118 \mbox{``mynameisuserx''}.}
\item 119 119 \item
{The System shall successfully receive the correct credentials and send an 120 120 {The System shall successfully receive the correct credentials and send an
email to the User's address with a link to validate the User's email address 121 121 email to the User's address with a link to validate the User's email address
and displays the Add Class page to the User.} 122 122 and displays the Add Class page to the User.}
\item 123 123 \item
{The System shall display a toast ``Please verify your email address! RESEND 124 124 {The System shall display a toast ``Please verify your email address! RESEND
VERIFICATION EMAIL''.} 125 125 VERIFICATION EMAIL''.}
\item 126 126 \item
{UserX receives an email with a link to verify their email. The 127 127 {UserX receives an email with a link to verify their email. The
User clicks the link (see Testing Notes).} 128 128 User clicks the link (see Testing Notes).}
\item 129 129 \item
{The System shall mark UserX's email as valid.} 130 130 {The System shall mark UserX's email as valid.}
\item 131 131 \item
{UserX shall click ``Logout'' (power button) in the top left corner.} 132 132 {UserX shall click ``Logout'' (power button) in the top left corner.}
\item 133 133 \item
{The System shall present UserX Login screen.} 134 134 {The System shall present UserX Login screen.}
\item 135 135 \item
{UserX shall once again login with \mbox{``UserX@flashy.cards''} and \mbox{``mynameisuserx''}.} 136 136 {UserX shall once again login with \mbox{``UserX@flashy.cards''} and \mbox{``mynameisuserx''}.}
\end{enumerate} 137 137 \end{enumerate}
138 138
\item [Expected Result:]{UserX shall see Add Class page without a toast asking 139 139 \item [Expected Result:]{UserX shall see Add Class page without a toast asking
UserX to verify their email.} 140 140 UserX to verify their email.}
141 141
\end{description} 142 142 \end{description}
\newpage 143 143 \newpage
144 144
{} 145 145 {}
146 146
\subsection{[A2] User Login} 147 147 \subsection{[A2] User Login}
148 148
\begin{description} 149 149 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 150 150 \item[Description:]{This test case outlines the presentation layering step
process of a user logging into the application.} 151 151 process of a user logging into the application.}
152 152
\item[Desired Outcome:]{The User shall be able to provide their email address and 153 153 \item[Desired Outcome:]{The User shall be able to provide their email address and
password to access their courses and flashcards. The User shall gain 154 154 password to access their courses and flashcards. The User shall gain
access to the list of the courses they have added, and be able to review 155 155 access to the list of the courses they have added, and be able to review
the flashcards they have added to their decks.} 156 156 the flashcards they have added to their decks.}
157 157
\item[User Goals:]{The User wants to resume use of the site on another 158 158 \item[User Goals:]{The User wants to resume use of the site on another
device, or use the site after logging out.} 159 159 device, or use the site after logging out.}
160 160
\item[Dependency Use Cases:]{[A1] User Registration} 161 161 \item[Dependency Use Cases:]{[A1] User Registration}
\\ 162 162 \\
163 163
\item[Priority Level:]{``Must''} 164 164 \item[Priority Level:]{``Must''}
165 165
\item[Status:]{Implemented} 166 166 \item[Status:]{Implemented}
167 167
\item[Preconditions:] 168 168 \item[Preconditions:]
\begin{itemize} 169 169 \begin{itemize}
\item 170 170 \item
{The User has created an account before with email \mbox{``UserX@flashy.cards''} with 171 171 {The User has created an account before with email \mbox{``UserX@flashy.cards''} with
password \mbox{``mynameisuserx''}.} 172 172 password \mbox{``mynameisuserx''}.}
\end{itemize} 173 173 \end{itemize}
174 174
\item[Postconditions:] 175 175 \item[Postconditions:]
\begin{itemize} 176 176 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 177 177 \itemsep1pt\parskip0pt\parsep0pt
\item 178 178 \item
{The user can navigate the site and see their data.} 179 179 {The user can navigate the site and see their data.}
\end{itemize} 180 180 \end{itemize}
181 181
\item[Trigger:]{UserX wants to view, add, or create cards for a class or classes.} 182 182 \item[Trigger:]{UserX wants to view, add, or create cards for a class or classes.}
183 183
\item[Workflow:] 184 184 \item[Workflow:]
\begin{enumerate} 185 185 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 186 186 \itemsep1pt\parskip0pt\parsep0pt
\item 187 187 \item
{UserX shall enter their email \mbox{``UserX@flashy.cards''} and password 188 188 {UserX shall enter their email \mbox{``UserX@flashy.cards''} and password
\mbox{``mynameisuserx''}.} 189 189 \mbox{``mynameisuserx''}.}
\item 190 190 \item
{The System shall authenticate UserX's email and password and checks if UserX is active.} 191 191 {The System shall authenticate UserX's email and password and checks if UserX is active.}
\item 192 192 \item
{The System shall receive the credentials and display the ``Add Class'' page to the User.} 193 193 {The System shall receive the credentials and display the ``Add Class'' page to the User.}
\end{enumerate} 194 194 \end{enumerate}
\item [Expected Result:] 195 195 \item [Expected Result:]
{The User is brought to the page ``Add Class''.}\\ 196 196 {The User is brought to the page ``Add Class''.}\\
197 197
\item [Alternate Workflow A:] 198 198 \item [Alternate Workflow A:]
\begin{enumerate} 199 199 \begin{enumerate}
\item 200 200 \item
{UserX accidentally puts in the credentials \mbox{``UserX@flashy.cards''}, 201 201 {UserX accidentally puts in the credentials \mbox{``UserX@flashy.cards''},
\mbox{``hahahaha''} and clicks the ``Login'' button.} 202 202 \mbox{``hahahaha''} and clicks the ``Login'' button.}
\item 203 203 \item
{The System shows UserX the site login page with a message reading 204 204 {The System shows UserX the site login page with a message reading
``Invalid username or password!!''.} 205 205 ``Invalid username or password!!''.}
\end {enumerate} 206 206 \end {enumerate}
207 207
\item [Expected Result:] 208 208 \item [Expected Result:]
{The User is not able to login.} \\ 209 209 {The User is not able to login.} \\
210 210
\item [Alternate Workflow B:] 211 211 \item [Alternate Workflow B:]
\begin{enumerate} 212 212 \begin{enumerate}
\item 213 213 \item
{UserX accidentally puts in the credentials \mbox{``NotUserX@flashy.cards''}, 214 214 {UserX accidentally puts in the credentials \mbox{``NotUserX@flashy.cards''},
\mbox{``mynameisuserx''} and clicks the ``Login'' button.} 215 215 \mbox{``mynameisuserx''} and clicks the ``Login'' button.}
\item 216 216 \item
{The System shows UserX the site login page with a message reading 217 217 {The System shows UserX the site login page with a message reading
``Invalid username or password!!''.} 218 218 ``Invalid username or password!!''.}
\end {enumerate} 219 219 \end {enumerate}
220 220
\item [Expected Result:] 221 221 \item [Expected Result:]
{The User is not able to login.} \\ 222 222 {The User is not able to login.} \\
223 223
\item [Alternate Workflow C:] 224 224 \item [Alternate Workflow C:]
\begin{enumerate} 225 225 \begin{enumerate}
\item 226 226 \item
{UserX accidentally puts in the credentials \mbox{``theflash@flashy.cards''}, 227 227 {UserX accidentally puts in the credentials \mbox{``theflash@flashy.cards''},
\mbox{``MyNameIsUserX''} and clicks the ``Login'' button.} 228 228 \mbox{``MyNameIsUserX''} and clicks the ``Login'' button.}
\item 229 229 \item
{The System shows UserX the site login page with a message reading 230 230 {The System shows UserX the site login page with a message reading
``Invalid username or password!!''.} 231 231 ``Invalid username or password!!''.}
\end {enumerate} 232 232 \end {enumerate}
233 233
\item [Expected Result:] 234 234 \item [Expected Result:]
{The User is not able to login.} \\ 235 235 {The User is not able to login.} \\
236 236
\end{description} 237 237 \end{description}
\newpage 238 238 \newpage
239 239
{} 240 240 {}
241 241
\subsection{[A3] Add a Class} 242 242 \subsection{[A3] Add a Class}
\begin{description} 243 243 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 244 244 \item[Description:]{This test case outlines the presentation layering step
process of a user adding a class.} 245 245 process of a user adding a class.}
246 246
\item[Desired Outcome:]{The class shall be linked with the student's account 247 247 \item[Desired Outcome:]{The class shall be linked with the student's account
and the student shall have the ability to read and publish flashcards 248 248 and the student shall have the ability to read and publish flashcards
for this class.} 249 249 for this class.}
250 250
\item[User Goals:]{The User wants to publish flashcards for this class and 251 251 \item[User Goals:]{The User wants to publish flashcards for this class and
read the flashcards for this class that are published by other users.} 252 252 read the flashcards for this class that are published by other users.}
253 253
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login} 254 254 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login}
\\ 255 255 \\
256 256
\item[Priority Level:]{``Must''} 257 257 \item[Priority Level:]{``Must''}
258 258
\item[Status:]{Implemented} 259 259 \item[Status:]{Implemented}
260 260
\item[Preconditions:] 261 261 \item[Preconditions:]
\begin{itemize} 262 262 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 263 263 \itemsep1pt\parskip0pt\parsep0pt
\item 264 264 \item
{The User is logged in as UserX.} 265 265 {The User is logged in as UserX.}
\item 266 266 \item
{The User is whitelisted for class TEST 101.} 267 267 {The User is whitelisted for class TEST 101.}
\item 268 268 \item
{The User is not whitelisted for class TEST 102.} 269 269 {The User is not whitelisted for class TEST 102.}
\item 270 270 \item
{The class TEST 103 has no whitelist.} 271 271 {The class TEST 103 has no whitelist.}
\end{itemize} 272 272 \end{itemize}
273 273
\item[Postconditions:] 274 274 \item[Postconditions:]
\begin{itemize} 275 275 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 276 276 \itemsep1pt\parskip0pt\parsep0pt
\item 277 277 \item
{The User can read the flashcards being published for the class and 278 278 {The User can read the flashcards being published for the class and
add them to their deck.} 279 279 add them to their deck.}
\item 280 280 \item
{The User can publish flashcards to be viewed and added by other users 281 281 {The User can publish flashcards to be viewed and added by other users
in the same class.} 282 282 in the same class.}
\end{itemize} 283 283 \end{itemize}
284 284
\item[Trigger:]{UserX wants to view the Live Feed and have a flashcard deck for a class.} 285 285 \item[Trigger:]{UserX wants to view the Live Feed and have a flashcard deck for a class.}
286 286
\item[Workflow:] 287 287 \item[Workflow:]
\begin{enumerate} 288 288 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 289 289 \itemsep1pt\parskip0pt\parsep0pt
\item 290 290 \item
{UserX shall click ``Add Class'' on the classes dropdown from the navigation bar.} 291 291 {UserX shall click ``Add Class'' on the classes dropdown from the navigation bar.}
\item 292 292 \item
{The System shall show the user ``Add Class'' page.} 293 293 {The System shall show the user ``Add Class'' page.}
\item 294 294 \item
{UserX shall begin to type ``TEST 101''.} 295 295 {UserX shall begin to type ``TEST 101''.}
\item 296 296 \item
{The System shall show suggestions as a user types.} 297 297 {The System shall show suggestions as a user types.}
\item 298 298 \item
{The System shall check if there is a whitelist for each class in the suggestions.} 299 299 {The System shall check if there is a whitelist for each class in the suggestions.}
\item 300 300 \item
{The System shall ensure that UserX is on the whitelist for each section.} 301 301 {The System shall ensure that UserX is on the whitelist for each section.}
\item 302 302 \item
{UserX shall click on ``TEST 101'', which should not have a lock icon.} 303 303 {UserX shall click on ``TEST 101'', which should not have a lock icon.}
\item 304 304 \item
{UserX shall click on the ``Add'' button.} 305 305 {UserX shall click on the ``Add'' button.}
\item 306 306 \item
{The System shall add UserX to the specified class TEST 101.} 307 307 {The System shall add UserX to the specified class TEST 101.}
\end{enumerate} 308 308 \end{enumerate}
309 309
\item[Expected Result:] {UserX has added the section and sees the Live Feed 310 310 \item[Expected Result:] {UserX has added the section and sees the Live Feed
for TEST 101.} 311 311 for TEST 101.}
312 312
\item[Alternate Workflow A:] 313 313 \item[Alternate Workflow A:]
\begin{enumerate} 314 314 \begin{enumerate}
\setcounter{enumi}{3} 315 315 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 316 316 \itemsep1pt\parskip0pt\parsep0pt
\item 317 317 \item
{UserX shall begin to type ``TEST 102''.} 318 318 {UserX shall begin to type ``TEST 102''.}
\item 319 319 \item
{The System shall show suggestions as a user types.} 320 320 {The System shall show suggestions as a user types.}
\item 321 321 \item
{The System shall check if there is a whitelist for each class in the suggestions.} 322 322 {The System shall check if there is a whitelist for each class in the suggestions.}
\item 323 323 \item
{The System shall see that UserX is not on the whitelist.} 324 324 {The System shall see that UserX is not on the whitelist.}
\item 325 325 \item
{UserX shall see a lock icon in the suggestions for TEST 102.} 326 326 {UserX shall see a lock icon in the suggestions for TEST 102.}
\item 327 327 \item
{UserX shall click on ``TEST 102'', which has a lock icon.} 328 328 {UserX shall click on ``TEST 102'', which has a lock icon.}
\item 329 329 \item
{The System shall disable the ``Add'' button.} 330 330 {The System shall disable the ``Add'' button.}
\end{enumerate} 331 331 \end{enumerate}
332 332
\item[Expected Result:] {UserX cannot add the specified TEST 102 and cannot 333 333 \item[Expected Result:] {UserX cannot add the specified TEST 102 and cannot
view contents related to this class.} 334 334 view contents related to this class.}
335 335
\item[Alternate Workflow B:] 336 336 \item[Alternate Workflow B:]
\begin{enumerate} 337 337 \begin{enumerate}
\setcounter{enumi}{3} 338 338 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 339 339 \itemsep1pt\parskip0pt\parsep0pt
\item 340 340 \item
{UserX shall begin to type ``TEST 103''.} 341 341 {UserX shall begin to type ``TEST 103''.}
\item 342 342 \item
{The System shall show suggestions as UserX types.} 343 343 {The System shall show suggestions as UserX types.}
\item 344 344 \item
{The System shall check if there is a whitelist for each class in the suggestions.} 345 345 {The System shall check if there is a whitelist for each class in the suggestions.}
\item 346 346 \item
{The System shall see there is no whitelist for TEST 103.} 347 347 {The System shall see there is no whitelist for TEST 103.}
\item 348 348 \item
{UserX shall click on ``TEST 103'', which should not have a lock icon.} 349 349 {UserX shall click on ``TEST 103'', which should not have a lock icon.}
\item 350 350 \item
{UserX shall click on the ``Add'' button.} 351 351 {UserX shall click on the ``Add'' button.}
\item 352 352 \item
{The System shall add UserX to TEST 103.} 353 353 {The System shall add UserX to TEST 103.}
\end{enumerate} 354 354 \end{enumerate}
355 355
\item[Expected Result:] {UserX has added the section and sees the Live Feed 356 356 \item[Expected Result:] {UserX has added the section and sees the Live Feed
for TEST 103.} 357 357 for TEST 103.}
\end{description} 358 358 \end{description}
\newpage 359 359 \newpage
360 360
{} 361 361 {}
362 362
\subsection{[A4] Drop a Class} 363 363 \subsection{[A4] Drop a Class}
364 364
\begin{description} 365 365 \begin{description}
\item[Description:]{This test case outlines the presentation layering step process of a user dropping a class.} 366 366 \item[Description:]{This test case outlines the presentation layering step process of a user dropping a class.}
367 367
\item[Desired Outcome:]{The User has dropped the class and no longer needs 368 368 \item[Desired Outcome:]{The User has dropped the class and no longer needs
access to the flashcards for the dropped class. They can no longer 369 369 access to the flashcards for the dropped class. They can no longer
see the flashcards associated to the class that they dropped.} 370 370 see the flashcards associated to the class that they dropped.}
371 371
\item[User Goals:]{The User shall not have access to a class and the 372 372 \item[User Goals:]{The User shall not have access to a class and the
flashcards associated with that class. They will no longer see the class 373 373 flashcards associated with that class. They will no longer see the class
listed in their list of ``Enrolled Classes''.} 374 374 listed in their list of ``Enrolled Classes''.}
375 375
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login, [A3] Add a Class} 376 376 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login, [A3] Add a Class}
\\ 377 377 \\
378 378
\item[Priority Level:]{``Should''} 379 379 \item[Priority Level:]{``Should''}
380 380
\item[Status:]{Implemented} 381 381 \item[Status:]{Implemented}
382 382
\item[Preconditions:] 383 383 \item[Preconditions:]
\begin{itemize} 384 384 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 385 385 \itemsep1pt\parskip0pt\parsep0pt
\item 386 386 \item
{The User is logged in as UserX.} 387 387 {The User is logged in as UserX.}
\item 388 388 \item
{The User has enrolled in TEST 101.} 389 389 {The User has enrolled in TEST 101.}
\item 390 390 \item
{The User is at Settings page.} 391 391 {The User is at Settings page.}
\end{itemize} 392 392 \end{itemize}
393 393
\item[Postconditions:] 394 394 \item[Postconditions:]
\begin{itemize} 395 395 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 396 396 \itemsep1pt\parskip0pt\parsep0pt
\item 397 397 \item
{The User shall no longer have access to TEST 101, or associated flashcards.} 398 398 {The User shall no longer have access to TEST 101, or associated flashcards.}
\end{itemize} 399 399 \end{itemize}
400 400
\item[Trigger:]{UserX wants to stop seeing the class's Live Feed and remove 401 401 \item[Trigger:]{UserX wants to stop seeing the class's Live Feed and remove
all of their flashcards.} 402 402 all of their flashcards.}
403 403
\item[Workflow:] 404 404 \item[Workflow:]
\begin{enumerate} 405 405 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 406 406 \itemsep1pt\parskip0pt\parsep0pt
\item 407 407 \item
{UserX shall click ``X'' icon next to TEST 101 in ``Enrolled Classes'' table.} 408 408 {UserX shall click ``X'' icon next to TEST 101 in ``Enrolled Classes'' table.}
\item 409 409 \item
{The System shall remove UserX from TEST 101.} 410 410 {The System shall remove UserX from TEST 101.}
\item 411 411 \item
{The System shall display a toast indicating that a class has been dropped.} 412 412 {The System shall display a toast indicating that a class has been dropped.}
\end{enumerate} 413 413 \end{enumerate}
414 414
\item[Expected Result:] {UserX no longer has access to any content related to TEST 101.} 415 415 \item[Expected Result:] {UserX no longer has access to any content related to TEST 101.}
\end{description} 416 416 \end{description}
\newpage 417 417 \newpage
418 418
{} 419 419 {}
420 420
\subsection{[A5] Password Change} 421 421 \subsection{[A5] Password Change}
422 422
\begin{description} 423 423 \begin{description}
\item[Description:]{This test case outlines the presentation layering step process 424 424 \item[Description:]{This test case outlines the presentation layering step process
of a user changing their password.} 425 425 of a user changing their password.}
426 426
\item[Desired Outcome:]{The User's password shall be changed and the user 427 427 \item[Desired Outcome:]{The User's password shall be changed and the user
shall be able to log in with the new password in the future.} 428 428 shall be able to log in with the new password in the future.}
429 429
\item[User Goals:]{The User wants to use a different password in the future.} 430 430 \item[User Goals:]{The User wants to use a different password in the future.}
431 431
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login} 432 432 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login}
\\ 433 433 \\
434 434
\item[Priority Level:]{``Must''} 435 435 \item[Priority Level:]{``Must''}
436 436
\item[Status:]{Implemented} 437 437 \item[Status:]{Implemented}
438 438
\item[Preconditions:] 439 439 \item[Preconditions:]
\begin{itemize} 440 440 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 441 441 \itemsep1pt\parskip0pt\parsep0pt
\item 442 442 \item
{The User is logged in as UserX.} 443 443 {The User is logged in as UserX.}
\item 444 444 \item
{The User knows the current password \mbox{``mynameisuserx''}.} 445 445 {The User knows the current password \mbox{``mynameisuserx''}.}
\item 446 446 \item
{The User is at the Settings page.} 447 447 {The User is at the Settings page.}
\end{itemize} 448 448 \end{itemize}
449 449
\item[Postconditions:] 450 450 \item[Postconditions:]
\begin{itemize} 451 451 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 452 452 \itemsep1pt\parskip0pt\parsep0pt
\item 453 453 \item
{The User's password is changed} 454 454 {The User's password is changed}
\item 455 455 \item
{The User can log in with the new password} 456 456 {The User can log in with the new password}
\end{itemize} 457 457 \end{itemize}
458 458
\item[Trigger:]{UserX is dissatisfied with their current password and wishes 459 459 \item[Trigger:]{UserX is dissatisfied with their current password and wishes
to change it.} 460 460 to change it.}
461 461
\item[Workflow:] 462 462 \item[Workflow:]
\begin{enumerate} 463 463 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 464 464 \itemsep1pt\parskip0pt\parsep0pt
\item 465 465 \item
{UserX shall enter their current password \mbox{``mynameisuserx''} and the desired 466 466 {UserX shall enter their current password \mbox{``mynameisuserx''} and the desired
new password \mbox{``newPassword''} (twice) in the ``Change Password'' form.} 467 467 new password \mbox{``newPassword''} (twice) in the ``Change Password'' form.}
\item 468 468 \item
{UserX shall click the ``Submit'' button.} 469 469 {UserX shall click the ``Submit'' button.}
\item 470 470 \item
{The System shall check UserX's current password.} 471 471 {The System shall check UserX's current password.}
\item 472 472 \item
{The System shall update the UserX's current password \mbox{``mynameisuserx''} 473 473 {The System shall update the UserX's current password \mbox{``mynameisuserx''}
to the new password \mbox{``newPassword''}.} 474 474 to the new password \mbox{``newPassword''}.}
\end{enumerate} 475 475 \end{enumerate}
476 476
\item[Expected Result:] {User's password is changed from \mbox{``mynameisuserx''} 477 477 \item[Expected Result:] {User's password is changed from \mbox{``mynameisuserx''}
to \mbox{``newPassword''}.} 478 478 to \mbox{``newPassword''}.}
\\ 479 479 \\
480 480
\item[Alternate Workflow A:] 481 481 \item[Alternate Workflow A:]
\begin{enumerate} 482 482 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 483 483 \itemsep1pt\parskip0pt\parsep0pt
\item 484 484 \item
{UserX shall enter an incorrect current password \mbox{``MyNameIsUserX''} and the desired 485 485 {UserX shall enter an incorrect current password \mbox{``MyNameIsUserX''} and the desired
new password \mbox{``newPassword''} (twice) in the ``Change Password'' form.} 486 486 new password \mbox{``newPassword''} (twice) in the ``Change Password'' form.}
\item 487 487 \item
{UserX shall click the ``Submit'' button.} 488 488 {UserX shall click the ``Submit'' button.}
\item 489 489 \item
{The System shall ensure validity of new password.} 490 490 {The System shall ensure validity of new password.}
\item 491 491 \item
{The System shall check UserX's current password.} 492 492 {The System shall check UserX's current password.}
\end{enumerate} 493 493 \end{enumerate}
494 494
\item[Expected Result:] {The System shall display a toast ``Your old password is not correct''.} 495 495 \item[Expected Result:] {The System shall display a toast ``Your old password is not correct''.}
\\ 496 496 \\
497 497
\item[Alternate Workflow B:] 498 498 \item[Alternate Workflow B:]
\begin{enumerate} 499 499 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 500 500 \itemsep1pt\parskip0pt\parsep0pt
\item 501 501 \item
{UserX shall enter their current password \mbox{``mynameisuserx''} and the desired 502 502 {UserX shall enter their current password \mbox{``mynameisuserx''} and the desired
new password \mbox{``newPass''} (twice) in the ``Change Password'' form.} 503 503 new password \mbox{``newPass''} (twice) in the ``Change Password'' form.}
\item 504 504 \item
{UserX shall click the ``Submit'' button.} 505 505 {UserX shall click the ``Submit'' button.}
\item 506 506 \item
{The System shall ensure validity of new password.} 507 507 {The System shall ensure validity of new password.}
\end{enumerate} 508 508 \end{enumerate}
509 509
\item[Expected Result:] {The System shall display error text ``New password 510 510 \item[Expected Result:] {The System shall display error text ``New password
must be at least 8 characters.''} 511 511 must be at least 8 characters.''}
512 512
\end{description} 513 513 \end{description}
\newpage 514 514 \newpage
515 515
{} 516 516 {}
517 517
\subsection{[A6] Password Reset} 518 518 \subsection{[A6] Password Reset}
519 519
\begin{description} 520 520 \begin{description}
\item[Description:]{This test case outlines the presentation layering step process of 521 521 \item[Description:]{This test case outlines the presentation layering step process of
a user requesting a password reset without logging in.} 522 522 a user requesting a password reset without logging in.}
523 523
\item[Desired Outcome:]{The User's password shall be changed to one that 524 524 \item[Desired Outcome:]{The User's password shall be changed to one that
they remember.} 525 525 they remember.}
\\ 526 526 \\
527 527
\item[User Goals:]{The User does not know their current password but wants 528 528 \item[User Goals:]{The User does not know their current password but wants
to log into the site.} 529 529 to log into the site.}
530 530
\item[Dependency Use Cases:]{[A1] User Registration} 531 531 \item[Dependency Use Cases:]{[A1] User Registration}
\\ 532 532 \\
533 533
\item[Priority Level:]{``Must''} 534 534 \item[Priority Level:]{``Must''}
535 535
\item[Status]{Implemented} 536 536 \item[Status]{Implemented}
537 537
\item[Preconditions:] 538 538 \item[Preconditions:]
\begin{itemize} 539 539 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 540 540 \itemsep1pt\parskip0pt\parsep0pt
\item 541 541 \item
{Account for UserX has been created.} 542 542 {Account for UserX has been created.}
\end{itemize} 543 543 \end{itemize}
544 544
\item[Postconditions:] 545 545 \item[Postconditions:]
\begin{itemize} 546 546 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 547 547 \itemsep1pt\parskip0pt\parsep0pt
\item 548 548 \item
{UserX's password is changed.} 549 549 {UserX's password is changed.}
\item 550 550 \item
{UserX can log in with the new password.} 551 551 {UserX can log in with the new password.}
\end{itemize} 552 552 \end{itemize}
553 553
\item[Trigger:]{UserX forgot their password and wants to access the site.} 554 554 \item[Trigger:]{UserX forgot their password and wants to access the site.}
555 555
\item[Workflow:] 556 556 \item[Workflow:]
\begin{enumerate} 557 557 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 558 558 \itemsep1pt\parskip0pt\parsep0pt
\item 559 559 \item
{UserX shall click the ``Forgot Password'' hyperlink.} 560 560 {UserX shall click the ``Forgot Password'' hyperlink.}
\item 561 561 \item
{The System shall prompt the user for their current email.} 562 562 {The System shall prompt the user for their current email.}
\item 563 563 \item
{UserX shall submit their email \mbox{``UserX@flashy.cards''}.} 564 564 {UserX shall submit their email \mbox{``UserX@flashy.cards''}.}
\item 565 565 \item
{The System shall check if an account exists with the email entered by UserX.} 566 566 {The System shall check if an account exists with the email entered by UserX.}
\item 567 567 \item
{The System shall create a new password reset token for UserX.} 568 568 {The System shall create a new password reset token for UserX.}
\item 569 569 \item
{The System shall send an email to UserX with a link containing the token and the 570 570 {The System shall send an email to UserX with a link containing the token and the
user's ID.} 571 571 user's ID.}
\item 572 572 \item
{UserX shall click the link in the email to visit /app/password\_reset.} 573 573 {UserX shall click the link in the email to visit /app/password\_reset.}
\item 574 574 \item
{The System shall render a form that will prompt the user for a new password.} 575 575 {The System shall render a form that will prompt the user for a new password.}
\item 576 576 \item
{UserX shall provide a new password, \mbox{``newPassword''}, in the form.} 577 577 {UserX shall provide a new password, \mbox{``newPassword''}, in the form.}
\item 578 578 \item
{The System shall change the password associated with the user's email.} 579 579 {The System shall change the password associated with the user's email.}
\item 580 580 \item
{UserX shall navigate back to the login page and enter \mbox{``UserX@flashy.cards''} 581 581 {UserX shall navigate back to the login page and enter \mbox{``UserX@flashy.cards''}
with the old password \mbox{``mynameisuserx''}.} 582 582 with the old password \mbox{``mynameisuserx''}.}
\item 583 583 \item
{The System shall display ``Invalid username or password!''} 584 584 {The System shall display ``Invalid username or password!''}
\item 585 585 \item
{UserX shall login as \mbox{``UserX@flashy.cards''} with the password \mbox{``newPassword''}.} 586 586 {UserX shall login as \mbox{``UserX@flashy.cards''} with the password \mbox{``newPassword''}.}
\end{enumerate} 587 587 \end{enumerate}
588 588
\item[Expected Result:] {UserX shall be logged in.} 589 589 \item[Expected Result:] {UserX shall be logged in.}
\\ 590 590 \\
591 591
\item[Alternate Workflow:] 592 592 \item[Alternate Workflow:]
\begin{enumerate} 593 593 \begin{enumerate}
\setcounter{enumi}{2} 594 594 \setcounter{enumi}{2}
\itemsep1pt\parskip0pt\parsep0pt 595 595 \itemsep1pt\parskip0pt\parsep0pt
\item 596 596 \item
{UserX shall submit an invalid email \mbox{``NotUserX@flashy.cards''}.} 597 597 {UserX shall submit an invalid email \mbox{``NotUserX@flashy.cards''}.}
\item 598 598 \item
{The System shall display an error message ``Enter a valid email!'' to UserX.} 599 599 {The System shall display an error message ``Enter a valid email!'' to UserX.}
\end{enumerate} 600 600 \end{enumerate}
601 601
\item[Expected Result:] {UserX's password will not be reset.} 602 602 \item[Expected Result:] {UserX's password will not be reset.}
\end{description} 603 603 \end{description}
\newpage 604 604 \newpage
605 605
{} 606 606 {}
607 607
\subsection{[A7] Student Prevented From Accessing A Restricted Course} 608 608 \subsection{[A7] Student Prevented From Accessing A Restricted Course}
609 609
\begin{description} 610 610 \begin{description}
\item[Description:]{This test case outlines the presentation layering step process of 611 611 \item[Description:]{This test case outlines the presentation layering step process of
an instructor limiting access to a class.} 612 612 an instructor limiting access to a class.}
613 613
\item[Desired Outcome:]{The class will have limited access and only those 614 614 \item[Desired Outcome:]{The class will have limited access and only those
users who are whitelisted may enroll in the class.} 615 615 users who are whitelisted may enroll in the class.}
616 616
\item[User Goals:]{The instructor wants to limit access to his class so only 617 617 \item[User Goals:]{The instructor wants to limit access to his class so only
the students who are actually in his class participate, and nobody 618 618 the students who are actually in his class participate, and nobody
else.} 619 619 else.}
620 620
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login} 621 621 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login}
\\ 622 622 \\
623 623
\item[Priority Level:]{``Should''} 624 624 \item[Priority Level:]{``Should''}
625 625
\item[Status:]{Deferred (see Add a Class)} 626 626 \item[Status:]{Deferred (see Add a Class)}
627 627
\item[Preconditions:] 628 628 \item[Preconditions:]
\begin{itemize} 629 629 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 630 630 \itemsep1pt\parskip0pt\parsep0pt
\item 631 631 \item
{UserX has valid instructor's account} 632 632 {UserX has valid instructor's account}
\end{itemize} 633 633 \end{itemize}
634 634
\item[Postconditions:] 635 635 \item[Postconditions:]
\begin{itemize} 636 636 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 637 637 \itemsep1pt\parskip0pt\parsep0pt
\item 638 638 \item
{Only those users who were whitelisted may add the class.} 639 639 {Only those users who were whitelisted may add the class.}
\end{itemize} 640 640 \end{itemize}
641 641
\item[Trigger:]{The instructor emails the administrator and requests to 642 642 \item[Trigger:]{The instructor emails the administrator and requests to
limit access to his class.} 643 643 limit access to his class.}
644 644
\item[Workflow:] 645 645 \item[Workflow:]
\begin{enumerate} 646 646 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 647 647 \itemsep1pt\parskip0pt\parsep0pt
\item 648 648 \item
{The instructor, ``INSTR1'', shall email the administrators from his UCSD email address 649 649 {The instructor, ``INSTR1'', shall email the administrators from his UCSD email address
and requests to limit access to his course.} 650 650 and requests to limit access to his course.}
\item 651 651 \item
{ INSTR1 shall provide a list of 652 652 { INSTR1 shall provide a list of
emails of the students that are to be whitelisted.} 653 653 emails of the students that are to be whitelisted.}
\item 654 654 \item
{The administrators shall visit a custom admin page, select the course, and 655 655 {The administrators shall visit a custom admin page, select the course, and
paste the list of emails.} 656 656 paste the list of emails.}
\item 657 657 \item
{The administrators shall submit the page directly to the System.} 658 658 {The administrators shall submit the page directly to the System.}
\item 659 659 \item
{The System shall create a WhitelistedAddress for each provided email, 660 660 {The System shall create a WhitelistedAddress for each provided email,
attaching it to the section taught by INST1.} 661 661 attaching it to the section taught by INST1.}
\item 662 662 \item
{The System shall add any existing users whose email addresses appear 663 663 {The System shall add any existing users whose email addresses appear
in the whitelist to the class. } 664 664 in the whitelist to the class. }
\end{enumerate} 665 665 \end{enumerate}
666 666
\item[Expected Result:] {A whitelist is added to a section.} 667 667 \item[Expected Result:] {A whitelist is added to a section.}
\end{description} 668 668 \end{description}
\newpage 669 669 \newpage
670 670
{} 671 671 {}
672 672
\subsection{[A8] User Logout} 673 673 \subsection{[A8] User Logout}
674 674
\begin{description} 675 675 \begin{description}
\item[Description:]{This test case outlines the presentation layering step process 676 676 \item[Description:]{This test case outlines the presentation layering step process
of a user logging out from their account.} 677 677 of a user logging out from their account.}
678 678
\item[Desired Outcome:]{The User's information and data will no longer be 679 679 \item[Desired Outcome:]{The User's information and data will no longer be
accessible after logging out. } 680 680 accessible after logging out. }
681 681
\item[User Goals:]{The User is done with their session of using the 682 682 \item[User Goals:]{The User is done with their session of using the
website, and wants to make sure others cannot access the data in their 683 683 website, and wants to make sure others cannot access the data in their
account.} 684 684 account.}
685 685
\item[Dependency Use Cases:] {[A1] User Registration, [A2] User Login} 686 686 \item[Dependency Use Cases:] {[A1] User Registration, [A2] User Login}
\\ 687 687 \\
688 688
\item[Priority Level:]{``Must''} 689 689 \item[Priority Level:]{``Must''}
690 690
\item[Status:]{Implemented} 691 691 \item[Status:]{Implemented}
692 692
\item[Preconditions:] 693 693 \item[Preconditions:]
\begin{itemize} 694 694 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 695 695 \itemsep1pt\parskip0pt\parsep0pt
\item 696 696 \item
{The user is logged in as UserX.} 697 697 {The user is logged in as UserX.}
\end{itemize} 698 698 \end{itemize}
699 699
\item[Postconditions:] 700 700 \item[Postconditions:]
\begin{itemize} 701 701 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 702 702 \itemsep1pt\parskip0pt\parsep0pt
\item 703 703 \item
{The user's data can no longer be accessed.} 704 704 {The user's data can no longer be accessed.}
\end{itemize} 705 705 \end{itemize}
706 706
\item[Trigger:] {UserX does not currently want access to the site and does 707 707 \item[Trigger:] {UserX does not currently want access to the site and does
not want others tampering with their account.} 708 708 not want others tampering with their account.}
709 709
\item[Workflow:] 710 710 \item[Workflow:]
\begin{enumerate} 711 711 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 712 712 \itemsep1pt\parskip0pt\parsep0pt
\item 713 713 \item
{UserX shall click ``Logout'' (power button) in the top right.} 714 714 {UserX shall click ``Logout'' (power button) in the top right.}
\item 715 715 \item
{The System shall log out UserX.} 716 716 {The System shall log out UserX.}
\item 717 717 \item
{The System shall redirect UserX to the login page.} 718 718 {The System shall redirect UserX to the login page.}
\end{enumerate} 719 719 \end{enumerate}
720 720
\item[Expected Result:] {UserX is logged out and on the login page.} 721 721 \item[Expected Result:] {UserX is logged out and on the login page.}
\end{description} 722 722 \end{description}
\newpage 723 723 \newpage
724 724
{} 725 725 {}
726 726
\subsection{[A9] Contact Admin} 727 727 \subsection{[A9] Contact Admin}
728 728
\begin{description} 729 729 \begin{description}
\item[Description]{This test case outlines the presentation layering step 730 730 \item[Description]{This test case outlines the presentation layering step
process of a user contacting site admins.} 731 731 process of a user contacting site admins.}
732 732
\item[Desired Outcome]{The User shall send a message to the admin; the 733 733 \item[Desired Outcome]{The User shall send a message to the admin; the
admin shall receive the message.} 734 734 admin shall receive the message.}
735 735
\item[User Goals:]{The User sends a message to the admin.} 736 736 \item[User Goals:]{The User sends a message to the admin.}
737 737
\item[Dependency Use Cases]{None} 738 738 \item[Dependency Use Cases]{None}
\\ 739 739 \\
740 740
\item[Priority Level]{``Must''} 741 741 \item[Priority Level]{``Must''}
742 742
\item[Status]{Not Implemented and Deferred} 743 743 \item[Status]{Not Implemented and Deferred}
744 744
\item[Pre-conditions]{None.} 745 745 \item[Pre-conditions]{None.}
746 746
\item[Post-conditions]{The admin receives the user's message.} 747 747 \item[Post-conditions]{The admin receives the user's message.}
748 748
\item[Trigger]{UserX wants to contact the administrators of our application.} 749 749 \item[Trigger]{UserX wants to contact the administrators of our application.}
750 750
\item[Workflow] 751 751 \item[Workflow]
\begin{enumerate} 752 752 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 753 753 \itemsep1pt\parskip0pt\parsep0pt
\item 754 754 \item
{The System shall display the admin email address on every page in the 755 755 {The System shall display the admin email address on every page in the
application.} 756 756 application.}
\end{enumerate} 757 757 \end{enumerate}
758 758
\item[Expected Result:] {The admin's email address can be seen by UserX on every page.} 759 759 \item[Expected Result:] {The admin's email address can be seen by UserX on every page.}
\end{description} 760 760 \end{description}
\newpage 761 761 \newpage
762 762
{} 763 763 {}
764 764
\subsection{[A10] Configure Account Notifications} 765 765 \subsection{[A10] Configure Account Notifications}
\begin{description} 766 766 \begin{description}
\item[Description]{This test case outlines the presentation layering step process of a user configuring notification settings.} 767 767 \item[Description]{This test case outlines the presentation layering step process of a user configuring notification settings.}
768 768
\item[Desired Outcome]{The User shall only receive notifications at the 769 769 \item[Desired Outcome]{The User shall only receive notifications at the
times that were specified.} 770 770 times that were specified.}
\\ 771 771 \\
772 772
\item[User Goals]{The User shall not be bothered needlessly or at 773 773 \item[User Goals]{The User shall not be bothered needlessly or at
inconvenient times.} 774 774 inconvenient times.}
775 775
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login} 776 776 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login}
\\ 777 777 \\
778 778
\item[Priority Level]{``Must''} 779 779 \item[Priority Level]{``Must''}
780 780
\item[Status]{Deferred} 781 781 \item[Status]{Deferred}
782 782
\item[Preconditions:] 783 783 \item[Preconditions:]
\begin{itemize} 784 784 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 785 785 \itemsep1pt\parskip0pt\parsep0pt
\item 786 786 \item
{The User is logged in as UserX.} 787 787 {The User is logged in as UserX.}
\end{itemize} 788 788 \end{itemize}
789 789
\item[Postconditions:] 790 790 \item[Postconditions:]
\begin{itemize} 791 791 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 792 792 \itemsep1pt\parskip0pt\parsep0pt
\item 793 793 \item
{User only receive notifications at specified times} 794 794 {User only receive notifications at specified times}
\end{itemize} 795 795 \end{itemize}
796 796
\item[Trigger]{UserX wants to change their notification settings} 797 797 \item[Trigger]{UserX wants to change their notification settings}
798 798
\item[Workflow] 799 799 \item[Workflow]
\begin{enumerate} 800 800 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 801 801 \itemsep1pt\parskip0pt\parsep0pt
\item 802 802 \item
{UserX shall select ``Settings'' (gear) from the top right.} 803 803 {UserX shall select ``Settings'' (gear) from the top right.}
\item 804 804 \item
{The System shall display a settings screen.} 805 805 {The System shall display a settings screen.}
\item 806 806 \item
{UserX shall change the notification timing to 1 min.} 807 807 {UserX shall change the notification timing to 1 min.}
\item 808 808 \item
{UserX shall click ``Save Settings'' button.} 809 809 {UserX shall click ``Save Settings'' button.}
\item 810 810 \item
{The System shall display a message confirming the settings are saved.} 811 811 {The System shall display a message confirming the settings are saved.}
\item 812 812 \item
{The System shall save notification settings to the user's attributes.} 813 813 {The System shall save notification settings to the user's attributes.}
\end{enumerate} 814 814 \end{enumerate}
815 815
\item[Expected Result:]{UserX shall be notified at least as slow as 1 min.} 816 816 \item[Expected Result:]{UserX shall be notified at least as slow as 1 min.}
\end{description} 817 817 \end{description}
\newpage 818 818 \newpage
819 819
{} 820 820 {}
821 821
\section{Flashcards} 822 822 \section{Flashcards}
\subsection{[F1] Push Flashcard} 823 823 \subsection{[F1] Push Flashcard}
824 824
\begin{description} 825 825 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 826 826 \item[Description:]{This test case outlines the presentation layering step
process of a User contributing a flashcard to the live feed and to their deck.} 827 827 process of a User contributing a flashcard to the live feed and to their deck.}
828 828
\item[Desired Outcome:]{The User shall have the flashcard added to their own deck 829 829 \item[Desired Outcome:]{The User shall have the flashcard added to their own deck
and the live feed.} 830 830 and the live feed.}
\\ 831 831 \\
832 832
\item[User Goals:]{The User will see their flashcard in their deck and the 833 833 \item[User Goals:]{The User will see their flashcard in their deck and the
flashcard will be shared with others.} 834 834 flashcard will be shared with others.}
835 835
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login, [A3] Add a Class} 836 836 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login, [A3] Add a Class}
\\ 837 837 \\
838 838
\item[Priority Level:]{``Must''} 839 839 \item[Priority Level:]{``Must''}
840 840
\item[Status:]{Implemented} 841 841 \item[Status:]{Implemented}
842 842
\item[Preconditions:] 843 843 \item[Preconditions:]
\begin{itemize} 844 844 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 845 845 \itemsep1pt\parskip0pt\parsep0pt
\item 846 846 \item
{The User is logged as UserX.} 847 847 {The User is logged as UserX.}
\item 848 848 \item
{The User is logged in a different browser session as UserY (see Testing Notes).} 849 849 {The User is logged in a different browser session as UserY (see Testing Notes).}
\item 850 850 \item
{UserX and UserY have added the class TEST 101.} 851 851 {UserX and UserY have added the class TEST 101.}
\item 852 852 \item
{UserX and UserY are on the live feed for TEST 101.} 853 853 {UserX and UserY are on the live feed for TEST 101.}
\end{itemize} 854 854 \end{itemize}
855 855
\item[Postconditions:] 856 856 \item[Postconditions:]
\begin{itemize} 857 857 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 858 858 \itemsep1pt\parskip0pt\parsep0pt
\item 859 859 \item
{UserX has flashcard added to their deck.} 860 860 {UserX has flashcard added to their deck.}
\item 861 861 \item
{The Flashcard is shown in the live feed.} 862 862 {The Flashcard is shown in the live feed.}
\item 863 863 \item
{UserY and other users can add this flashcard to their decks.} 864 864 {UserY and other users can add this flashcard to their decks.}
\end{itemize} 865 865 \end{itemize}
866 866
\item[Trigger:]{UserX wants to contribute a flashcard to the class TEST 101.} 867 867 \item[Trigger:]{UserX wants to contribute a flashcard to the class TEST 101.}
868 868
\item[Workflow:] 869 869 \item[Workflow:]
\begin{enumerate} 870 870 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 871 871 \itemsep1pt\parskip0pt\parsep0pt
\item {UserX has clicked the circular plus button (``Compose'' button) in 872 872 \item {UserX has clicked the circular plus button (``Compose'' button) in
the lower right corner of the live feed.} 873 873 the lower right corner of the live feed.}
\item 874 874 \item
{The System shall present a modal with a text box.} 875 875 {The System shall present a modal with a text box.}
\item 876 876 \item
{UserX shall select the input field of the modal and type ``The rain in Spain stays mainly in the plain''.} 877 877 {UserX shall select the input field of the modal and type ``The rain in Spain stays mainly in the plain''.}
\item 878 878 \item
{UserX shall select the ``Contribute'' button in the modal.} 879 879 {UserX shall select the ``Contribute'' button in the modal.}
\item 880 880 \item
{The System shall add the new card containing the text ``The rain in Spain stays mainly in 881 881 {The System shall add the new card containing the text ``The rain in Spain stays mainly in
the plain'' to the feed of each user enrolled in ``TEST 101''.} 882 882 the plain'' to the feed of each user enrolled in ``TEST 101''.}
\item 883 883 \item
{UserY shall see the card appear in their feed within a minute (See Notes).} 884 884 {UserY shall see the card appear in their feed within a minute (See Notes).}
\item 885 885 \item
{The System shall hide the modal from UserX.} 886 886 {The System shall hide the modal from UserX.}
\item 887 887 \item
{The flashcard shall be included in the UserX's deck.(c.f. Note about simultaneous browser session).} 888 888 {The flashcard shall be included in the UserX's deck.(c.f. Note about simultaneous browser session).}
\end{enumerate} 889 889 \end{enumerate}
890 890
\item[Expected Result:] {UserX will have the new flashcard in their deck. 891 891 \item[Expected Result:] {UserX will have the new flashcard in their deck.
For UserX, the new flashcard will have a checkmark, indicating that the card 892 892 For UserX, the new flashcard will have a checkmark, indicating that the card
is in their deck and a pencil icon on top right to indicate UserX as 893 893 is in their deck and a pencil icon on top right to indicate UserX as
the author of the flashcard. The new flashcard will show up on UserY's 894 894 the author of the flashcard. The new flashcard will show up on UserY's
live feed on class TEST 101 without checkmark and pencil icon.} 895 895 live feed on class TEST 101 without checkmark and pencil icon.}
896 896
\item[Alternative Workflow:] 897 897 \item[Alternative Workflow:]
\begin{enumerate} 898 898 \begin{enumerate}
\setcounter{enumi}{3} 899 899 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 900 900 \itemsep1pt\parskip0pt\parsep0pt
\item 901 901 \item
{UserX shall user their cursor to select the word Spain in the text box, 902 902 {UserX shall user their cursor to select the word Spain in the text box,
then click the ``Blank Word'' button.} 903 903 then click the ``Blank Word'' button.}
\item 904 904 \item
{The System shall bold the word Spain.} 905 905 {The System shall bold the word Spain.}
\item 906 906 \item
{UserX shall use the cursor to select the word ``plain'' in the text box, 907 907 {UserX shall use the cursor to select the word ``plain'' in the text box,
then click the ``Blank Word'' button.} 908 908 then click the ``Blank Word'' button.}
\item 909 909 \item
{The System shall bold the word plain.} 910 910 {The System shall bold the word plain.}
\item 911 911 \item
{UserX shall click the ``Contribute'' button in the modal.} 912 912 {UserX shall click the ``Contribute'' button in the modal.}
\item 913 913 \item
{The System shall add the new flashcard containing the text ``The rain in 914 914 {The System shall add the new flashcard containing the text ``The rain in
\textbf{Spain} stays mainly in the \textbf{plain}'' to the feed of each user enrolled in TEST.} 915 915 \textbf{Spain} stays mainly in the \textbf{plain}'' to the feed of each user enrolled in TEST.}
\item 916 916 \item
{UserY shall view the live feed and within a minute see the new flashcard 917 917 {UserY shall view the live feed and within a minute see the new flashcard
appear with ``Spain'' and ``plain'' bolded.} 918 918 appear with ``Spain'' and ``plain'' bolded.}
\end{enumerate} 919 919 \end{enumerate}
920 920
\item[Expected Result:] { 921 921 \item[Expected Result:] {
UserX will have the new flashcard with the words ``Spain'' and ``plain'' bolded in their deck. 922 922 UserX will have the new flashcard with the words ``Spain'' and ``plain'' bolded in their deck.
For UserX, the new flashcard will have a checkmark, 923 923 For UserX, the new flashcard will have a checkmark,
indicating that the card is in their deck and a pencil icon on 924 924 indicating that the card is in their deck and a pencil icon on
top right to indicate UserX as the author of the flashcard. 925 925 top right to indicate UserX as the author of the flashcard.
The new flashcard will show up on UserY's live feed on class TEST 101 926 926 The new flashcard will show up on UserY's live feed on class TEST 101
without checkmark and pencil icon.} 927 927 without checkmark and pencil icon.}
928 928
\item[Alternate Workflow:] 929 929 \item[Alternate Workflow:]
\begin{enumerate} 930 930 \begin{enumerate}
\setcounter{enumi}{2} 931 931 \setcounter{enumi}{2}
\itemsep1pt\parskip0pt\parsep0pt 932 932 \itemsep1pt\parskip0pt\parsep0pt
\item 933 933 \item
{UserX shall select the input field of the modal and type five blank spaces.} 934 934 {UserX shall select the input field of the modal and type five blank spaces.}
\item 935 935 \item
{UserX shall click the ``Contribute'' button in the dialog.} 936 936 {UserX shall click the ``Contribute'' button in the dialog.}
\end{enumerate} 937 937 \end{enumerate}
938 938
\item[Expected Result:] {Blank flashcard will not be added to UserX's deck or 939 939 \item[Expected Result:] {Blank flashcard will not be added to UserX's deck or
to the live feed of TEST 101.} 940 940 to the live feed of TEST 101.}
941 941
\item[Alternate Workflow:] 942 942 \item[Alternate Workflow:]
\begin{enumerate} 943 943 \begin{enumerate}
\setcounter{enumi}{2} 944 944 \setcounter{enumi}{2}
\itemsep1pt\parskip0pt\parsep0pt 945 945 \itemsep1pt\parskip0pt\parsep0pt
\item 946 946 \item
{UserX shall select the input field and type ``Test''.} 947 947 {UserX shall select the input field and type ``Test''.}
\item 948 948 \item
{UserX shall click the ``Contribute'' button in the dialog.} 949 949 {UserX shall click the ``Contribute'' button in the dialog.}
\end{enumerate} 950 950 \end{enumerate}
951 951
\item[Expected Result:] 952 952 \item[Expected Result:]
{ Flashcard with input not meeting the length restriction will not be added to 953 953 { Flashcard with input not meeting the length restriction will not be added to
UserX's deck or to the live feed of TEST 101.} 954 954 UserX's deck or to the live feed of TEST 101.}
955 955
\end{description} 956 956 \end{description}
\newpage 957 957 \newpage
958 958
{} 959 959 {}
960 960
\subsection{[F2] Edit Flashcard} 961 961 \subsection{[F2] Edit Flashcard}
962 962
\begin{description} 963 963 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 964 964 \item[Description:]{This test case outlines the presentation layering step
process of a user editting a flashcard.} 965 965 process of a user editting a flashcard.}
966 966
\item[Desired Outcome:]{Flashcard is edited and saved appropriately} 967 967 \item[Desired Outcome:]{Flashcard is edited and saved appropriately}
\\ 968 968 \\
969 969
\item[User Goals:]{The User shall be able to change the text and the blanked words on a flashcard.} 970 970 \item[User Goals:]{The User shall be able to change the text and the blanked words on a flashcard.}
971 971
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 972 972 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard, [F3] Pull Flashcard} 973 973 Login, [A3] Add a Class, [F1] Push Flashcard, [F3] Pull Flashcard}
974 974
\item[Priority Level:]{``Should''} 975 975 \item[Priority Level:]{``Should''}
976 976
\item[Status:]{Implemented} 977 977 \item[Status:]{Implemented}
978 978
\item[Preconditions:] 979 979 \item[Preconditions:]
\begin{itemize} 980 980 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 981 981 \itemsep1pt\parskip0pt\parsep0pt
\item 982 982 \item
{The User is logged in as UserX.} 983 983 {The User is logged in as UserX.}
\item 984 984 \item
{The User is logged in a different browser session as UserY.} 985 985 {The User is logged in a different browser session as UserY.}
\item 986 986 \item
{User has added the class TEST 101.} 987 987 {User has added the class TEST 101.}
\item 988 988 \item
{TEST 101 contains the flashcard ``This is made for edit'' 989 989 {TEST 101 contains the flashcard ``This is made for edit''
, which was made by other user and is not in UserX's deck.} 990 990 , which was made by other user and is not in UserX's deck.}
\item 991 991 \item
{UserX has the flashcard ``I have made an \textbf{error}'', 992 992 {UserX has the flashcard ``I have made an \textbf{error}'',
which was created by UserX, and was pulled by UserY.} 993 993 which was created by UserX, and was pulled by UserY.}
\item 994 994 \item
{UserX is at the live feed of TEST 101.} 995 995 {UserX is at the live feed of TEST 101.}
\end{itemize} 996 996 \end{itemize}
997 997
\item[Postconditions:] 998 998 \item[Postconditions:]
\begin{itemize} 999 999 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1000 1000 \itemsep1pt\parskip0pt\parsep0pt
\item 1001 1001 \item
{The selected flashcards are edited.} 1002 1002 {The selected flashcards are edited.}
\end{itemize} 1003 1003 \end{itemize}
1004 1004
\item[Trigger:]{The User wants to edit existing flashcards.} 1005 1005 \item[Trigger:]{The User wants to edit existing flashcards.}
1006 1006
\item[Workflow:] 1007 1007 \item[Workflow:]
\begin{enumerate} 1008 1008 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1009 1009 \itemsep1pt\parskip0pt\parsep0pt
\item 1010 1010 \item
{UserX shall hover the cursor over the flashcard 1011 1011 {UserX shall hover the cursor over the flashcard
``this is made for edit''.} 1012 1012 ``this is made for edit''.}
\item 1013 1013 \item
{UserX shall click the blue pencil edit icon on 1014 1014 {UserX shall click the blue pencil edit icon on
the bottom left of the hovered flashcard.} 1015 1015 the bottom left of the hovered flashcard.}
\item 1016 1016 \item
{The System shall present a modal that contains the 1017 1017 {The System shall present a modal that contains the
``this is made for edit'' of the selected flashcard.} 1018 1018 ``this is made for edit'' of the selected flashcard.}
\item 1019 1019 \item
{UserX shall select the entire text.} 1020 1020 {UserX shall select the entire text.}
\item 1021 1021 \item
{UserX shall change the text to ``Edit has been made''.} 1022 1022 {UserX shall change the text to ``Edit has been made''.}
\item 1023 1023 \item
{UserX shall click 'SAVE CHANGES'} 1024 1024 {UserX shall click 'SAVE CHANGES'}
\item 1025 1025 \item
{The System shall hide the modal from UserX.} 1026 1026 {The System shall hide the modal from UserX.}
\end{enumerate} 1027 1027 \end{enumerate}
1028 1028
\item[Expected Result:]{UserX shall see a new flashcard with the 1029 1029 \item[Expected Result:]{UserX shall see a new flashcard with the
text ``Edit has been made'' added to the top of the feed and the new 1030 1030 text ``Edit has been made'' added to the top of the feed and the new
flashcard will be added to UserX's deck. 1031 1031 flashcard will be added to UserX's deck.
The flashcard with the text ``this is made for edit'' 1032 1032 The flashcard with the text ``this is made for edit''
will be hidden from UserX.} 1033 1033 will be hidden from UserX.}
1034 1034
\item[Alternate Workflow A:] 1035 1035 \item[Alternate Workflow A:]
\begin{enumerate} 1036 1036 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1037 1037 \itemsep1pt\parskip0pt\parsep0pt
\item 1038 1038 \item
{UserX shall move the cursor over the flash card 1039 1039 {UserX shall move the cursor over the flash card
``I have made an \textbf{error}''.} 1040 1040 ``I have made an \textbf{error}''.}
\item 1041 1041 \item
{UserX shall click the blue pencil edit icon on 1042 1042 {UserX shall click the blue pencil edit icon on
the bottom left of the hovered flashcard.} 1043 1043 the bottom left of the hovered flashcard.}
\item 1044 1044 \item
{The System shall present a modal that contains the text 1045 1045 {The System shall present a modal that contains the text
``I have made an \textbf{error}'' of the selected flashcard.} 1046 1046 ``I have made an \textbf{error}'' of the selected flashcard.}
\item 1047 1047 \item
{UserX shall select the bolded text ``\textbf{error}''} 1048 1048 {UserX shall select the bolded text ``\textbf{error}''}
\item 1049 1049 \item
{UserX shall select } 1050 1050 {UserX shall select }
\item 1051 1051 \item
{UserX shall click ``Save Changes''.} 1052 1052 {UserX shall click ``Save Changes''.}
\item 1053 1053 \item
{The System shall hide the modal from UserX.} 1054 1054 {The System shall hide the modal from UserX.}
\item 1055 1055 \item
{The selected flashcard's blanked words shall be 1056 1056 {The selected flashcard's blanked words shall be
changed to ``fun''.} 1057 1057 changed to ``fun''.}
\end{enumerate} 1058 1058 \end{enumerate}
1059 1059
\item[Expected Result:]{The selected flashcard's blanked words shall be changed to ``fun''.} 1060 1060 \item[Expected Result:]{The selected flashcard's blanked words shall be changed to ``fun''.}
1061 1061
\item[Alternate Workflow B:] 1062 1062 \item[Alternate Workflow B:]
\begin{enumerate} 1063 1063 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1064 1064 \itemsep1pt\parskip0pt\parsep0pt
\item 1065 1065 \item
{UserX shall hover the cursor over the flashcard 1066 1066 {UserX shall hover the cursor over the flashcard
``Edit has been made''.} 1067 1067 ``Edit has been made''.}
\item 1068 1068 \item
{UserX shall click the blue pencil edit icon on 1069 1069 {UserX shall click the blue pencil edit icon on
the bottom left of the hovered flashcard.} 1070 1070 the bottom left of the hovered flashcard.}
\item 1071 1071 \item
{The System shall present a modal that contains the 1072 1072 {The System shall present a modal that contains the
``Edit has been made'' of the selected flashcard.} 1073 1073 ``Edit has been made'' of the selected flashcard.}
\item 1074 1074 \item
{UserX shall select the entire text.} 1075 1075 {UserX shall select the entire text.}
\item 1076 1076 \item
{UserX shall change the text to blanks.} 1077 1077 {UserX shall change the text to blanks.}
\item 1078 1078 \item
{UserX shall click 'SAVE CHANGES' (button may not change 1079 1079 {UserX shall click 'SAVE CHANGES' (button may not change
color).} 1080 1080 color).}
\item 1081 1081 \item
{The System shall hide the modal from UserX.} 1082 1082 {The System shall hide the modal from UserX.}
\end{enumerate} 1083 1083 \end{enumerate}
1084 1084
\item[Expected Result:]{UserX shall see a new flashcard with the 1085 1085 \item[Expected Result:]{UserX shall see a new flashcard with the
text ``Edit has been made'' added to the top of the feed and the new 1086 1086 text ``Edit has been made'' added to the top of the feed and the new
flashcard will be added to UserX's deck. 1087 1087 flashcard will be added to UserX's deck.
The flashcard with the text ``this is made for edit'' 1088 1088 The flashcard with the text ``this is made for edit''
will be hidden from UserX.} 1089 1089 will be hidden from UserX.}
1090 1090
\item[Alternative Workflow B:] 1091 1091 \item[Alternative Workflow B:]
\begin{enumerate} 1092 1092 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1093 1093 \itemsep1pt\parskip0pt\parsep0pt
\item 1094 1094 \item
{UserX shall move the cursor over the flash card ``this is made for edit3''.} 1095 1095 {UserX shall move the cursor over the flash card ``this is made for edit3''.}
\item 1096 1096 \item
{UserX shall click the edit button on bottom left of the selected flashcard.} 1097 1097 {UserX shall click the edit button on bottom left of the selected flashcard.}
\item 1098 1098 \item
{The System shall present a modal that contains the text of the selected flashcard.} 1099 1099 {The System shall present a modal that contains the text of the selected flashcard.}
\item 1100 1100 \item
{UserX shall be able the study date to 6/12.} 1101 1101 {UserX shall be able the study date to 6/12.}
\item 1102 1102 \item
{UserX shall click 'Save'} 1103 1103 {UserX shall click 'Save'}
\item 1104 1104 \item
{The System shall hide the modal from UserX.} 1105 1105 {The System shall hide the modal from UserX.}
\end{enumerate} 1106 1106 \end{enumerate}
1107 1107
\item[Expected Result:]{The selected flashcard's study date shall be changed to 6/12.} 1108 1108 \item[Expected Result:]{The selected flashcard's study date shall be changed to 6/12.}
\end{description} 1109 1109 \end{description}
\newpage 1110 1110 \newpage
1111 1111
{} 1112 1112 {}
1113 1113
\subsection{[F3] Pull Flashcard} 1114 1114 \subsection{[F3] Pull Flashcard}
\begin{description} 1115 1115 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 1116 1116 \item[Description:]{This test case outlines the presentation layering step
process of a user pulling a flashcard.} 1117 1117 process of a user pulling a flashcard.}
1118 1118
\item[Desired Outcome:]{The User shall have the flashcard added to their deck.} 1119 1119 \item[Desired Outcome:]{The User shall have the flashcard added to their deck.}
\\ 1120 1120 \\
1121 1121
\item[User Goals:]{The User will be able to review that flashcard.} 1122 1122 \item[User Goals:]{The User will be able to review that flashcard.}
1123 1123
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1124 1124 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashard} 1125 1125 Login, [A3] Add a Class, [F1] Push Flashard}
1126 1126
\item[Priority Level:]{``Must'' } 1127 1127 \item[Priority Level:]{``Must'' }
1128 1128
\item[Status:]{Implemented} 1129 1129 \item[Status:]{Implemented}
1130 1130
\item[Preconditions:] 1131 1131 \item[Preconditions:]
\begin{itemize} 1132 1132 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1133 1133 \itemsep1pt\parskip0pt\parsep0pt
\item 1134 1134 \item
{The User is logged in as UserX.} 1135 1135 {The User is logged in as UserX.}
\item 1136 1136 \item
{User has registered for class TEST 101.} 1137 1137 {User has registered for class TEST 101.}
\item 1138 1138 \item
{User is at live feed for TEST 101.} 1139 1139 {User is at live feed for TEST 101.}
\item 1140 1140 \item
{That flashcard with the text ``Pull me'' is in the Live Feed of class TEST 101.} 1141 1141 {That flashcard with the text ``Pull me'' is in the Live Feed of class TEST 101.}
\end{itemize} 1142 1142 \end{itemize}
1143 1143
\item[Postconditions:] 1144 1144 \item[Postconditions:]
\begin{itemize} 1145 1145 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1146 1146 \itemsep1pt\parskip0pt\parsep0pt
\item 1147 1147 \item
{UserX shall have that flashcard with the text ``Pull me'' added to their deck} 1148 1148 {UserX shall have that flashcard with the text ``Pull me'' added to their deck}
\item 1149 1149 \item
{UserX shall be able to review this flashcard later} 1150 1150 {UserX shall be able to review this flashcard later}
\end{itemize} 1151 1151 \end{itemize}
1152 1152
\item[Trigger:]{UserX wants to add a flashcard to their deck to study it.} 1153 1153 \item[Trigger:]{UserX wants to add a flashcard to their deck to study it.}
1154 1154
\item[Workflow:] 1155 1155 \item[Workflow:]
1156 1156
\begin{enumerate} 1157 1157 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1158 1158 \itemsep1pt\parskip0pt\parsep0pt
\item 1159 1159 \item
{UserX shall choose the flashcard with the text ``Pull me'' from the 1160 1160 {UserX shall choose the flashcard with the text ``Pull me'' from the
class TEST 101 feed and hover their cursor over it.} 1161 1161 class TEST 101 feed and hover their cursor over it.}
\item 1162 1162 \item
{The System shall present buttons on mouseover.} 1163 1163 {The System shall present buttons on mouseover.}
\item 1164 1164 \item
{UserX shall click on the large plus that appears over the flashcard with the text ``Pull me''.} 1165 1165 {UserX shall click on the large plus that appears over the flashcard with the text ``Pull me''.}
\item 1166 1166 \item
{The System shall add the flashcard into UserX's deck. 1167 1167 {The System shall add the flashcard into UserX's deck.
A checkmark shall appear on top right corner of the flashcard.} 1168 1168 A checkmark shall appear on top right corner of the flashcard.}
\item 1169 1169 \item
{UserX shall click the ``Deck'' icon on the top left to enter their 1170 1170 {UserX shall click the ``Deck'' icon on the top left to enter their
deck.} 1171 1171 deck.}
\item 1172 1172 \item
{UserX shall check that the card with the text ``Pull me'' has been added to their class 1173 1173 {UserX shall check that the card with the text ``Pull me'' has been added to their class
TEST 101 deck.} 1174 1174 TEST 101 deck.}
\end{enumerate} 1175 1175 \end{enumerate}
1176 1176
\item[Expected Result:] {The flashcard with the text ``Pull me'' is in the class 1177 1177 \item[Expected Result:] {The flashcard with the text ``Pull me'' is in the class
TEST 101 deck. If UserX hovers the cursor over the flashcard at the live feed of 1178 1178 TEST 101 deck. If UserX hovers the cursor over the flashcard at the live feed of
TEST 101, the original placement of the large plus button has been changed to large minus button.} 1179 1179 TEST 101, the original placement of the large plus button has been changed to large minus button.}
\end{description} 1180 1180 \end{description}
\newpage 1181 1181 \newpage
1182 1182
{} 1183 1183 {}
1184 1184
\subsection{[F4] Flag Inappropriate Cards} 1185 1185 \subsection{[F4] Flag Inappropriate Cards}
1186 1186
\begin{description} 1187 1187 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 1188 1188 \item[Description:]{This test case outlines the presentation layering step
process of a user flagging a card they have deemed inappropriate.} 1189 1189 process of a user flagging a card they have deemed inappropriate.}
1190 1190
\item[Desired Outcome:]{The flashcard's inappropriateness variable is 1191 1191 \item[Desired Outcome:]{The flashcard's inappropriateness variable is
adjusted.} 1192 1192 adjusted.}
\\ 1193 1193 \\
1194 1194
\item[User Goals:]{To note if a card should not belong in the class and 1195 1195 \item[User Goals:]{To note if a card should not belong in the class and
should not be displayed in the feed.} 1196 1196 should not be displayed in the feed.}
1197 1197
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1198 1198 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard} 1199 1199 Login, [A3] Add a Class, [F1] Push Flashcard}
1200 1200
\item[Priority Level:]{``Should''} 1201 1201 \item[Priority Level:]{``Should''}
1202 1202
\item[Status:]{Implemented} 1203 1203 \item[Status:]{Implemented}
1204 1204
\item[Preconditions:] 1205 1205 \item[Preconditions:]
\begin{itemize} 1206 1206 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1207 1207 \itemsep1pt\parskip0pt\parsep0pt
\item 1208 1208 \item
{UserX has registered for a class TEST 101.} 1209 1209 {UserX has registered for a class TEST 101.}
\item 1210 1210 \item
{UserX is in the live feed for class TEST 101.} 1211 1211 {UserX is in the live feed for class TEST 101.}
\item 1212 1212 \item
{Flashcard with text ``TESTY FLASHY'' has been created for TEST 101.} 1213 1213 {Flashcard with text ``TESTY FLASHY'' has been created for TEST 101.}
\item 1214 1214 \item
{That flashcard ``TESTY FLASHY'' is in the Live Feed for TEST 101.} 1215 1215 {That flashcard ``TESTY FLASHY'' is in the Live Feed for TEST 101.}
\end{itemize} 1216 1216 \end{itemize}
1217 1217
\item[Postconditions:] 1218 1218 \item[Postconditions:]
\begin{itemize} 1219 1219 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1220 1220 \itemsep1pt\parskip0pt\parsep0pt
\item 1221 1221 \item
{User shall have that flashcard added to their deck} 1222 1222 {User shall have that flashcard added to their deck}
\item 1223 1223 \item
{User can review this flashcard later} 1224 1224 {User can review this flashcard later}
\end{itemize} 1225 1225 \end{itemize}
1226 1226
\item[Trigger:]{UserX wants to mark a card innapropriate.} 1227 1227 \item[Trigger:]{UserX wants to mark a card innapropriate.}
1228 1228
\item[Workflow:] 1229 1229 \item[Workflow:]
\begin{enumerate} 1230 1230 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1231 1231 \itemsep1pt\parskip0pt\parsep0pt
\item 1232 1232 \item
{UserX shall choose the flashcard with the text ``TESTY FLASHY'' from the 1233 1233 {UserX shall choose the flashcard with the text ``TESTY FLASHY'' from the
feed and hover their cursor over it.} 1234 1234 feed and hover their cursor over it.}
\item 1235 1235 \item
{The System shall present buttons on mouseover.} 1236 1236 {The System shall present buttons on mouseover.}
\item 1237 1237 \item
{UserX shall click on the crossed out eye icon (Hide) that appears on the card.} 1238 1238 {UserX shall click on the crossed out eye icon (Hide) that appears on the card.}
\item 1239 1239 \item
{The System shall hide the card from UserX and display a toast, ``Card hidden! If the card was spammy or abusive you may also REPORT''.} 1240 1240 {The System shall hide the card from UserX and display a toast, ``Card hidden! If the card was spammy or abusive you may also REPORT''.}
\item 1241 1241 \item
{UserX shall click the REPORT.} 1242 1242 {UserX shall click the REPORT.}
\end{enumerate} 1243 1243 \end{enumerate}
1244 1244
\item[Expected Result:] {The System shall display a toast, ``Report successful: thanks for letting us know!''} 1245 1245 \item[Expected Result:] {The System shall display a toast, ``Report successful: thanks for letting us know!''}
\end{description} 1246 1246 \end{description}
\newpage 1247 1247 \newpage
1248 1248
{} 1249 1249 {}
1250 1250
\subsection{[F5] Filter Flashcards} 1251 1251 \subsection{[F5] Filter Flashcards}
1252 1252
\begin{description} 1253 1253 \begin{description}
\item[Description:]{This test case outlines the presentation layering process 1254 1254 \item[Description:]{This test case outlines the presentation layering process
of a user filtering existing flashcards to view only a specified subset.} 1255 1255 of a user filtering existing flashcards to view only a specified subset.}
1256 1256
\item[Desired Outcome:]{The User shall see flashcards based on the filter 1257 1257 \item[Desired Outcome:]{The User shall see flashcards based on the filter
options.} 1258 1258 options.}
1259 1259
\item[User Goals:]{The User can find what they are specifically looking 1260 1260 \item[User Goals:]{The User can find what they are specifically looking
for} 1261 1261 for}
1262 1262
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1263 1263 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard, [F3] Pull 1264 1264 Login, [A3] Add a Class, [F1] Push Flashcard, [F3] Pull
Flashcard} 1265 1265 Flashcard}
1266 1266
\item[Priority Level:]{``Should''} 1267 1267 \item[Priority Level:]{``Should''}
1268 1268
\item[Status:]{Implemented} 1269 1269 \item[Status:]{Implemented}
1270 1270
\item[Preconditions:] 1271 1271 \item[Preconditions:]
\begin{itemize} 1272 1272 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1273 1273 \itemsep1pt\parskip0pt\parsep0pt
\item 1274 1274 \item
{User is logged in as UserX.} 1275 1275 {User is logged in as UserX.}
\item 1276 1276 \item
{UserX has registered for the class TEST 101.} 1277 1277 {UserX has registered for the class TEST 101.}
\item 1278 1278 \item
{There exist flashcards in TEST 101 with the text ``apple'' and ``banana'' 1279 1279 {There exist flashcards in TEST 101 with the text ``apple'' and ``banana''
for each week in the quarter.} 1280 1280 for each week in the quarter.}
\item 1281 1281 \item
{There exist flashcards in TEST 101 with the text ``orange'' that are hidden 1282 1282 {There exist flashcards in TEST 101 with the text ``orange'' that are hidden
for each week in the quarter.} 1283 1283 for each week in the quarter.}
\item 1284 1284 \item
{UserX is at Card List View for the class.} 1285 1285 {UserX is at Card List View for the class.}
\end{itemize} 1286 1286 \end{itemize}
1287 1287
\item[Postconditions:] 1288 1288 \item[Postconditions:]
\begin{itemize} 1289 1289 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1290 1290 \itemsep1pt\parskip0pt\parsep0pt
\item 1291 1291 \item
{User only sees flashcards pertaining to selected dates.} 1292 1292 {User only sees flashcards pertaining to selected dates.}
\end{itemize} 1293 1293 \end{itemize}
1294 1294
\item[Trigger:]{User is looking for specific flashcards.} 1295 1295 \item[Trigger:]{User is looking for specific flashcards.}
1296 1296
\item[Workflow:] 1297 1297 \item[Workflow:]
\begin{enumerate} 1298 1298 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1299 1299 \itemsep1pt\parskip0pt\parsep0pt
\item 1300 1300 \item
{UserX shall deselect ``Week Nine'' from top.} 1301 1301 {UserX shall deselect ``Week Nine'' from top.}
\item 1302 1302 \item
{The System shall hide all cards from Week 9.} 1303 1303 {The System shall hide all cards from Week 9.}
\item 1304 1304 \item
{UserX shall search for ``app'' in the search bar in the top right.} 1305 1305 {UserX shall search for ``app'' in the search bar in the top right.}
\item 1306 1306 \item
{The System shall display only cards including text ``app''.} 1307 1307 {The System shall display only cards including text ``app''.}
\item 1308 1308 \item
{UserX shall click ``Show Hidden'' button in the top left and clear 1309 1309 {UserX shall click ``Show Hidden'' button in the top left and clear
the text in the search box.} 1310 1310 the text in the search box.}
\item 1311 1311 \item
{The System shall display all cards, excluding those from Week 9.} 1312 1312 {The System shall display all cards, excluding those from Week 9.}
\end{enumerate} 1313 1313 \end{enumerate}
1314 1314
\item[Expected Result:] {UserX shall see 9 cards with text ``apple'', 9 cards with text ``banana'', and 9 cards with text ``orange'', distributed evenly among weeks.} 1315 1315 \item[Expected Result:] {UserX shall see 9 cards with text ``apple'', 9 cards with text ``banana'', and 9 cards with text ``orange'', distributed evenly among weeks.}
\end{description} 1316 1316 \end{description}
\newpage 1317 1317 \newpage
1318 1318
{} 1319 1319 {}
1320 1320
\subsection{[F6] Blank Out Words in Flashcard} 1321 1321 \subsection{[F6] Blank Out Words in Flashcard}
1322 1322
\begin{description} 1323 1323 \begin{description}
\item[Description:]{This test case outlines the presentation layering process 1324 1324 \item[Description:]{This test case outlines the presentation layering process
of the User to create keywords in a card they are pushing.} 1325 1325 of the User to create keywords in a card they are pushing.}
1326 1326
\item[Desired Outcome:]{The blanked out words (visually bolded) in the 1327 1327 \item[Desired Outcome:]{The blanked out words (visually bolded) in the
flashcard notify the System that they are keywords.} 1328 1328 flashcard notify the System that they are keywords.}
1329 1329
\item[User Goals:]{The User shall mark some words as keywords so the System 1330 1330 \item[User Goals:]{The User shall mark some words as keywords so the System
may later quiz the User by blanking out one keyword at a time and having the 1331 1331 may later quiz the User by blanking out one keyword at a time and having the
User enter what they think the keyword is.} 1332 1332 User enter what they think the keyword is.}
1333 1333
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1334 1334 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard} 1335 1335 Login, [A3] Add a Class, [F1] Push Flashcard}
1336 1336
\item[Priority Level:]{``Must''} 1337 1337 \item[Priority Level:]{``Must''}
1338 1338
\item[Status:]{Implemented} 1339 1339 \item[Status:]{Implemented}
1340 1340
\item[Preconditions:] 1341 1341 \item[Preconditions:]
\begin{itemize} 1342 1342 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1343 1343 \itemsep1pt\parskip0pt\parsep0pt
\item 1344 1344 \item
\item 1345 1345 \item
{The User is logged in as UserX.} 1346 1346 {The User is logged in as UserX.}
\item 1347 1347 \item
{The User has added the class TEST 101.} 1348 1348 {The User has added the class TEST 101.}
\item 1349 1349 \item
{The User is at the Feed View for the class TEST 101.} 1350 1350 {The User is at the Feed View for the class TEST 101.}
\end{itemize} 1351 1351 \end{itemize}
1352 1352
\item[Postconditions:] 1353 1353 \item[Postconditions:]
\begin{itemize} 1354 1354 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1355 1355 \itemsep1pt\parskip0pt\parsep0pt
\item 1356 1356 \item
{The blanked out words (keyword) ``Spain'' in the flashcard are marked with underline.} 1357 1357 {The blanked out words (keyword) ``Spain'' in the flashcard are marked with underline.}
\end{itemize} 1358 1358 \end{itemize}
1359 1359
\item[Trigger:] {The User wants their newly pushed card to have the keyword ``Spain''.} 1360 1360 \item[Trigger:] {The User wants their newly pushed card to have the keyword ``Spain''.}
1361 1361
\item[Workflow:] 1362 1362 \item[Workflow:]
\begin{enumerate} 1363 1363 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1364 1364 \itemsep1pt\parskip0pt\parsep0pt
\item 1365 1365 \item
{UserX shall click the Compose button (+ circle on bottom right) of Feed.} 1366 1366 {UserX shall click the Compose button (+ circle on bottom right) of Feed.}
\item 1367 1367 \item
{The System shall bring up the composition flashcard modal.} 1368 1368 {The System shall bring up the composition flashcard modal.}
\item 1369 1369 \item
{UserX shall type text ``The rain in Spain stays mainly in the plain'' 1370 1370 {UserX shall type text ``The rain in Spain stays mainly in the plain''
into the composition modal, replacing ``Write a flashcard''.} 1371 1371 into the composition modal, replacing ``Write a flashcard''.}
\item 1372 1372 \item
{UserX shall highlight the word ``Spain''.} 1373 1373 {UserX shall highlight the word ``Spain''.}
\item {UserX shall press Blank Selected Text button.} 1374 1374 \item {UserX shall press Blank Selected Text button.}
\item {UserX shall press Contribute button to push the flashcard.} 1375 1375 \item {UserX shall press Contribute button to push the flashcard.}
\item 1376 1376 \item
{The System will save the blanked out word in the Flashcard Mask of the 1377 1377 {The System will save the blanked out word in the Flashcard Mask of the
newly pushed flashcard.} 1378 1378 newly pushed flashcard.}
\item {The Feed shall display the new card with the keyword underlined.} 1379 1379 \item {The Feed shall display the new card with the keyword underlined.}
\end{enumerate} 1380 1380 \end{enumerate}
1381 1381
\item[Expected Result:] {The System shall show ``Spain'' underlined and bolded 1382 1382 \item[Expected Result:] {The System shall show ``Spain'' underlined and bolded
in the flashcard. The flashcard is visible in the Feed and Deck of class TEST 101.} 1383 1383 in the flashcard. The flashcard is visible in the Feed and Deck of class TEST 101.}
\end{description} 1384 1384 \end{description}
\newpage 1385 1385 \newpage
1386 1386
{} 1387 1387 {}
1388 1388
\subsection{[F7] Fix Flashcard} 1389 1389 \subsection{[F7] Fix Flashcard}
1390 1390
\begin{description} 1391 1391 \begin{description}
\item[Description:]{This Test Case outlines the presentation layering process 1392 1392 \item[Description:]{This Test Case outlines the presentation layering process
for the User to alter (``fix'') a flashcard they made originally and not have 1393 1393 for the User to alter (``fix'') a flashcard they made originally and not have
to make a new copy of it. It is only a ``fix'' if no other users have the 1394 1394 to make a new copy of it. It is only a ``fix'' if no other users have the
flashcard in their Decks AND the User is the author.} 1395 1395 flashcard in their Decks AND the User is the author.}
1396 1396
\item[Desired Outcome:]{The User shall change one of their flashcard's text 1397 1397 \item[Desired Outcome:]{The User shall change one of their flashcard's text
and that alteration will be visible to all users in the Feed.} 1398 1398 and that alteration will be visible to all users in the Feed.}
1399 1399
\item[User Goals:]{The User shall make their own authored flashcard say 1400 1400 \item[User Goals:]{The User shall make their own authored flashcard say
something different than it did originally.} 1401 1401 something different than it did originally.}
1402 1402
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1403 1403 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard} 1404 1404 Login, [A3] Add a Class, [F1] Push Flashcard}
1405 1405
\item[Priority Level:]{``Must''} 1406 1406 \item[Priority Level:]{``Must''}
1407 1407
\item[Status:]{Implemented} 1408 1408 \item[Status:]{Implemented}
1409 1409
\item[Preconditions:] 1410 1410 \item[Preconditions:]
\begin{itemize} 1411 1411 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1412 1412 \itemsep1pt\parskip0pt\parsep0pt
\item 1413 1413 \item
{The User is logged in as UserX.} 1414 1414 {The User is logged in as UserX.}
\item {The User is logged in a separate browser as UserY.} 1415 1415 \item {The User is logged in a separate browser as UserY.}
\item 1416 1416 \item
{UserX and UserY has enrolled in the class TEST 101.} 1417 1417 {UserX and UserY has enrolled in the class TEST 101.}
\item 1418 1418 \item
{UserX is at the Deck View for the class TEST 101.} 1419 1419 {UserX is at the Deck View for the class TEST 101.}
\item {UserY is at the Feed View for the class TEST 101.} 1420 1420 \item {UserY is at the Feed View for the class TEST 101.}
\item 1421 1421 \item
{The User has contributed and pushed a flashcard to the TEST 101 Feed, which is 1422 1422 {The User has contributed and pushed a flashcard to the TEST 101 Feed, which is
also in their Deck with text 1423 1423 also in their Deck with text
``My card is currently broken''; this flashcard is for fixing.} 1424 1424 ``My card is currently broken''; this flashcard is for fixing.}
\end{itemize} 1425 1425 \end{itemize}
1426 1426
\item[Postconditions:] 1427 1427 \item[Postconditions:]
\begin{itemize} 1428 1428 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1429 1429 \itemsep1pt\parskip0pt\parsep0pt
\item 1430 1430 \item
{The authoring User shall see their alteration for that flashcard in their 1431 1431 {The authoring User shall see their alteration for that flashcard in their
Feed and Deck for TEST 101.} 1432 1432 Feed and Deck for TEST 101.}
\item {Other users shall see the fixed flashcard in the Feed for TEST 101 if they 1433 1433 \item {Other users shall see the fixed flashcard in the Feed for TEST 101 if they
refresh the app.} 1434 1434 refresh the app.}
\end{itemize} 1435 1435 \end{itemize}
1436 1436
\item[Trigger:] {UserX realizes that a card they created previously does 1437 1437 \item[Trigger:] {UserX realizes that a card they created previously does
not say what they currently desire and wishes to change it.} 1438 1438 not say what they currently desire and wishes to change it.}
1439 1439
\item[Workflow:] 1440 1440 \item[Workflow:]
\begin{enumerate} 1441 1441 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1442 1442 \itemsep1pt\parskip0pt\parsep0pt
\item 1443 1443 \item
{UserX shall hover the Flashcard they created with text ``My card is currently 1444 1444 {UserX shall hover the Flashcard they created with text ``My card is currently
broken''.} 1445 1445 broken''.}
\item 1446 1446 \item
{UserX shall select the bottom-left blue Edit Card pencil button on the flashcard.} 1447 1447 {UserX shall select the bottom-left blue Edit Card pencil button on the flashcard.}
\item 1448 1448 \item
{The System shall bring up the flashcard Edit modal.} 1449 1449 {The System shall bring up the flashcard Edit modal.}
\item 1450 1450 \item
{UserX shall highlight the text ``broken''.} 1451 1451 {UserX shall highlight the text ``broken''.}
\item {UserX shall change the highlighted word into ``fixed'' so that the text 1452 1452 \item {UserX shall change the highlighted word into ``fixed'' so that the text
reads ``My card is currently fixed''.} 1453 1453 reads ``My card is currently fixed''.}
\item 1454 1454 \item
{UserX shall press the Save Changes button.} 1455 1455 {UserX shall press the Save Changes button.}
\item 1456 1456 \item
{The System shall update the flashcard's text content.} 1457 1457 {The System shall update the flashcard's text content.}
\item 1458 1458 \item
{The System shall close the edit flashcard modal.} 1459 1459 {The System shall close the edit flashcard modal.}
\item {The Client shall show the flashcard in the UserX's TEST 101 Deck with the 1460 1460 \item {The Client shall show the flashcard in the UserX's TEST 101 Deck with the
fixed text.} 1461 1461 fixed text.}
1462 1462
\item {UserY refreshes the TEST 101 Feed view and sees the flashcard ``My card is 1463 1463 \item {UserY refreshes the TEST 101 Feed view and sees the flashcard ``My card is
currently fixed''.} 1464 1464 currently fixed''.}
\end{enumerate} 1465 1465 \end{enumerate}
1466 1466
\item[Expected Results:]{The Client shall show the fixed flashcard 1467 1467 \item[Expected Results:]{The Client shall show the fixed flashcard
in UserX's TEST 101 class Deck with the new text:``My card is currently fixed''. 1468 1468 in UserX's TEST 101 class Deck with the new text:``My card is currently fixed''.
The Client shall show the fixed flashcard in UserY's TEST 101 Feed view as well, 1469 1469 The Client shall show the fixed flashcard in UserY's TEST 101 Feed view as well,
after page refresh.} 1470 1470 after page refresh.}
\end{description} 1471 1471 \end{description}
\newpage 1472 1472 \newpage
1473 1473
{} 1474 1474 {}
1475 1475
\subsection{[F8] Hide cards from feed} 1476 1476 \subsection{[F8] Hide cards from feed}
1477 1477
\begin{description} 1478 1478 \begin{description}
\item[Description:]{This test case outlines the presentation layering process 1479 1479 \item[Description:]{This test case outlines the presentation layering process
for the User shall be able to hide cards from their own view, on 1480 1480 for the User shall be able to hide cards from their own view, on
the Feed and Deck.} 1481 1481 the Feed and Deck.}
1482 1482
\item[Desired Outcome:]{The System marks the flashcard as hidden from the 1483 1483 \item[Desired Outcome:]{The System marks the flashcard as hidden from the
User so that the User cannot see the flashcard in the Feed or Deck.} 1484 1484 User so that the User cannot see the flashcard in the Feed or Deck.}
1485 1485
\item[User Goals:]{The flashcard is no longer visible to the User in the Feed or 1486 1486 \item[User Goals:]{The flashcard is no longer visible to the User in the Feed or
Deck views.} 1487 1487 Deck views.}
1488 1488
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1489 1489 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard} 1490 1490 Login, [A3] Add a Class, [F1] Push Flashcard}
1491 1491
\item[Priority Level:]{``Should''} 1492 1492 \item[Priority Level:]{``Should''}
1493 1493
\item[Status:]{Implemented} 1494 1494 \item[Status:]{Implemented}
1495 1495
\item[Preconditions:] 1496 1496 \item[Preconditions:]
\begin{itemize} 1497 1497 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1498 1498 \itemsep1pt\parskip0pt\parsep0pt
\item 1499 1499 \item
{The User is logged in as UserX.} 1500 1500 {The User is logged in as UserX.}
\item 1501 1501 \item
{The User has enrolled in the class TEST 101.} 1502 1502 {The User has enrolled in the class TEST 101.}
\item 1503 1503 \item
{The User is at the Feed View or Deck View (alternate workflow) 1504 1504 {The User is at the Feed View or Deck View (alternate workflow)
for the class TEST 101.} 1505 1505 for the class TEST 101.}
\item 1506 1506 \item
{The User has composed and contributed a flashcard to the Feed with text 1507 1507 {The User has composed and contributed a flashcard to the Feed with text
``The rain in Spain stays mainly in the plain''.} 1508 1508 ``The rain in Spain stays mainly in the plain''.}
\end{itemize} 1509 1509 \end{itemize}
1510 1510
\item[Postconditions:] 1511 1511 \item[Postconditions:]
\begin{itemize} 1512 1512 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1513 1513 \itemsep1pt\parskip0pt\parsep0pt
\item{Flashcard is not viewable by user in the Feed or Deck views in TEST 101.} 1514 1514 \item{Flashcard is not viewable by user in the Feed or Deck views in TEST 101.}
\end{itemize} 1515 1515 \end{itemize}
1516 1516
\item[Workflow:] 1517 1517 \item[Workflow:]
\begin{enumerate} 1518 1518 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1519 1519 \itemsep1pt\parskip0pt\parsep0pt
\item {UserX has navigated to the Feed View of TEST 101.} 1520 1520 \item {UserX has navigated to the Feed View of TEST 101.}
\item 1521 1521 \item
{UserX hovers the flashcard they added with the text ``The rain in Spain stays 1522 1522 {UserX hovers the flashcard they added with the text ``The rain in Spain stays
mainly in the plain''.} 1523 1523 mainly in the plain''.}
1524 1524
\item {UserX presses Hide button, which is the red crossed-out eye.} 1525 1525 \item {UserX presses Hide button, which is the red crossed-out eye.}
1526 1526
\item {The System shall hide the card.} 1527 1527 \item {The System shall hide the card.}
\item {The Client shall remove the card from view for UserX.} 1528 1528 \item {The Client shall remove the card from view for UserX.}
\item {A toast is shown on the client that allows the User to report the card.} 1529 1529 \item {A toast is shown on the client that allows the User to report the card.}
\item {The card is not shown on the Feed or Deck.} 1530 1530 \item {The card is not shown on the Feed or Deck.}
\end{enumerate} 1531 1531 \end{enumerate}
1532 1532
\item[Expected Result:]{The Client shows the Feed without the flashcard of text 1533 1533 \item[Expected Result:]{The Client shows the Feed without the flashcard of text
``The rain in Spain stays mainly in the plain''. A toast that allows UserX to 1534 1534 ``The rain in Spain stays mainly in the plain''. A toast that allows UserX to
report the card shows up temporarily.} 1535 1535 report the card shows up temporarily.}
1536 1536
\item[Alternate Workflow:] 1537 1537 \item[Alternate Workflow:]
1538 1538
\begin{enumerate} 1539 1539 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1540 1540 \itemsep1pt\parskip0pt\parsep0pt
\item {UserX has navigated to the Deck View of TEST 101.} 1541 1541 \item {UserX has navigated to the Deck View of TEST 101.}
\item 1542 1542 \item
{UserX hovers the flashcard they added with the text ``The rain in Spain stays 1543 1543 {UserX hovers the flashcard they added with the text ``The rain in Spain stays
mainly in the plain''.} 1544 1544 mainly in the plain''.}
1545 1545
\item {UserX presses hide button, which is the red crossed-out eye.} 1546 1546 \item {UserX presses hide button, which is the red crossed-out eye.}
1547 1547
\item {The System shall hide the card.} 1548 1548 \item {The System shall hide the card.}
\item {A toast is shown on the client that allows the User to report the card.} 1549 1549 \item {A toast is shown on the client that allows the User to report the card.}
\item {The card is not shown on the Feed or Deck.} 1550 1550 \item {The card is not shown on the Feed or Deck.}
\end{enumerate} 1551 1551 \end{enumerate}
1552 1552
1553 1553
\item[Expected Result:]{The Client shows the Deck without the flashcard of text 1554 1554 \item[Expected Result:]{The Client shows the Deck without the flashcard of text
``The rain in Spain stays mainly in the plain''. A toast that allows UserX to 1555 1555 ``The rain in Spain stays mainly in the plain''. A toast that allows UserX to
report the card shows up temporarily.} 1556 1556 report the card shows up temporarily.}
\end{description} 1557 1557 \end{description}
\newpage 1558 1558 \newpage
1559 1559
{} 1560 1560 {}
1561 1561
\subsection{[F9] View a Feed} 1562 1562 \subsection{[F9] View a Feed}
1563 1563
\begin{description} 1564 1564 \begin{description}
\item[Description:]{This test case outlines the presentation 1565 1565 \item[Description:]{This test case outlines the presentation
layering process process of a user viewing a class Feed.} 1566 1566 layering process process of a user viewing a class Feed.}
1567 1567
\item[Desired Outcome:]{The System shall show the user the 1568 1568 \item[Desired Outcome:]{The System shall show the user the