TESTING.md

This document describes the testing procedures for the Dinner Party app.

Table of Contents

• User story testing
  • User goals
  • Creator goals
• Code validation
  • Naming conventions used
  • PEP8 validation
    • run.py validation
    • planning.py validation
    • utilities.py validation
    • gsheet.py validation
  • HTML/CSS validation
• Feature testing
• User input validation
  • Y/N questions
    • Initial question
    • Single-step test cases
    • Double-step test cases
    • Add more dishes question
    • Single-step test cases
    • Double-step test cases
    • Check pantry question
    • Single-step test cases
    • Double-step test cases
  • Number from a range
    • Integer from a range (bounded)
      • Single-step test cases
      • Double-step test cases
    • Float from a range
      • Single-step test cases
      • Double-step test cases
• Flow testing
  • Database data validation
    • Devices & browsers
      • Devices
      • Browsers
• Bugs
  • Known bugs
  • Solved bugs

Table of contents generated with readme-toc

User story testing

The user stories from README.md are repeated here for convenience.

User goals

The same set of goals was determined for all users of the app regardless of whether they are first-time or returning users.

• [UX1] I want to have a user-friendly and easy to use shopping list generator.
• [UX2] I want to see what recipes are available at each stage of planning
• [UX3] I want to choose one or more recipes to shop for
• [UX4] I want to see the ingredients for the dish I selected
• [UX5] I want to get a shopping list of all ingredients correctly added
• [UX6] I want to adjust the shopping list based on the ingredients I already have
• [UX7] I want clear instructions on the next step at each stage of the process
• [UX8] I want to only see relevant information on the screen at each step of the process
• [UX9] I want to be able to visually distinguish different kinds of information on the screen
• [UX10] I want to know the result of each step/choice in the process

Goal	Feature facilitating the goal
UX1	Visual design
UX1	Interaction design
UX2	List of dishes adjusted for each step
UX3	Users can decide after adding each recipe if they want to add more
UX4	Selected dish and ingredients screen
UX5	ShoppingList objects and methods
UX6	Pantry checker function
UX7	Interaction design
UX8	Clear screen
UX9	Visual design
UX10	Confirmation messages

Creator goals

• [CR1] I want to create my first Python application
• [CR2] I want to create an application that fills a real-life need
• [CR3] I want to make use of Object Oriented Programming
• [CR4] I want to reduce code redundancy as much as possible
• [CR5] I want the app to handle all possible user input
• [CR6] I want the user to always be sure how to interact with the program
• [CR7] I want the app to be as visually appealing as possible under the given constraints of the template
• [CR8] I want to write code with future extensibility and scalability in mind

Goal	Feature facilitating the goal
CR1	The finished application
CR2	The application uses a real-life database
CR3	DishList and ShoppingList` classes and methods
CR4	Code design
CR5	Validator functions
CR6	Interaction design
CR7	Visual design
CR7	Website design
CR8	Code design

Code validation

Naming conventions used

• all class names are in CamelCase.
• all constant names are in ALL_CAPS.
• all variable names are in snake_case.
• following my mentor's suggestion, I changed the names of global variables (that are not constants) so that they always start with an underscore: _global_variable.

PEP8 validation

All 4 Python files written for this project were tested with the build-in PyCharm linter and the Code Institute PEP8 Linter throughout development.

In the current version, no errors were found.

run.py validation

planning.py validation

utilities.py validation

gsheet.py validation

HTML/CSS validation

As I decided to add some CSS styling to the HTML style provided in the project template, I also validated this with the W3C validator. In the current version, no errors or warnings were found (see this section of the README for more details).

Feature testing

User input validation

Y/N questions

3 such questions occur in the program flow:

• Initial question
• Add more dishes question
• Check pantry question

Initial question

Would you like to plan a dinner party? (Y/N):

Single-step test cases

Input	Expected answer	Result
other letter character	I did not understand. Please type Y or N:	✅
multiple letter characters	I did not understand. Please type Y or N:	✅
special character	I did not understand. Please type Y or N:	✅
multiple special characters	I did not understand. Please type Y or N:	✅
space	I did not understand. Please type Y or N:	✅
multiple spaces	I did not understand. Please type Y or N:	✅
empty string	I did not understand. Please type Y or N:	✅
number character	I did not understand. Please type Y or N:	✅
multiple number characters	I did not understand. Please type Y or N:	✅
Y or y	Here is the list of dishes you can choose from.	✅
N or n	Maybe some other time, then.	✅

Double-step test cases

Shorthand	Stands for
Y	Y or y
N	N or n
X	Any other character(s)

Input	Expected answer	Result
X then X	I did not understand[...] x2	✅
X then Y	I did not understand[...] Here is the list of dishes[...]	✅
X then N	I did not understand[...] Maybe some other time, then.	✅
Y then Y	not possible, program continues after 1st input	✅
Y then X	not possible, program continues after 1st input	✅
Y then N	not possible, program continues after 1st input	✅
N then N	not possible, program continues after 1st input	✅
N then X	not possible, program continues after 1st input	✅
N then Y	not possible, program continues after 1st input	✅

Add more dishes question

Would you like to add another dish? (Y/N):

Single-step test cases

Input	Expected answer	Result
other letter character	I did not understand. Please type Y or N:	✅
multiple letter characters	I did not understand. Please type Y or N:	✅
special character	I did not understand. Please type Y or N:	✅
multiple special characters	I did not understand. Please type Y or N:	✅
space	I did not understand. Please type Y or N:	✅
multiple spaces	I did not understand. Please type Y or N:	✅
empty string	I did not understand. Please type Y or N:	✅
number character	I did not understand. Please type Y or N:	✅
multiple number characters	I did not understand. Please type Y or N:	✅
Y or y	Cool, here is the list of dishes again:	✅
N or n	Got it! That's all for now, then.	✅

Double-step test cases

Shorthand	Stands for
Y	Y or y
N	N or n
X	Any other character(s)

Input	Expected answer	Result
X then X	I did not understand[...] x2	✅
X then Y	I did not understand[...] Cool, here is the list of dishes again:	✅
X then N	I did not understand[...] Got it! That's all for now, then.	✅
Y then Y	not possible, program continues after 1st input	✅
Y then X	not possible, program continues after 1st input	✅
Y then N	not possible, program continues after 1st input	✅
N then N	not possible, program continues after 1st input	✅
N then X	not possible, program continues after 1st input	✅
N then Y	not possible, program continues after 1st input	✅

Check pantry question

Would you like to check your pantry for ingredients (Y/N):

Single-step test cases

Input	Expected answer	Result
other letter character	I did not understand. Please type Y or N:	✅
multiple letter characters	I did not understand. Please type Y or N:	✅
special character	I did not understand. Please type Y or N:	✅
multiple special characters	I did not understand. Please type Y or N:	✅
space	I did not understand. Please type Y or N:	✅
multiple spaces	I did not understand. Please type Y or N:	✅
empty string	I did not understand. Please type Y or N:	✅
number character	I did not understand. Please type Y or N:	✅
multiple number characters	I did not understand. Please type Y or N:	✅
Y or y	Let's check your pantry, then!	✅
N or n	Got it! That's all for now, then.	✅

Double-step test cases

Shorthand	Stands for
Y	Y or y
N	N or n
X	Any other character(s)

Input	Expected answer	Result
X then X	I did not understand[...] x2	✅
X then Y	I did not understand[...] Let's check your pantry, then!	✅
X then N	I did not understand[...] Got it! That's all for now, then.	✅
Y then Y	not possible, program continues after 1st input	✅
Y then X	not possible, program continues after 1st input	✅
Y then N	not possible, program continues after 1st input	✅
N then N	not possible, program continues after 1st input	✅
N then X	not possible, program continues after 1st input	✅
N then Y	not possible, program continues after 1st input	✅

Number from a range

Integer from a range (bounded)

Type in the number of the dish you'd like to add:

This input method accepts integers between 1 and the length of the list of dishes (this changes dynamically from 14 to 1). Both the lower and the upper bound is accepted.

Single-step test cases

Input	Expected answer	Result
letter character	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
multiple letter characters	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
special character	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
multiple special characters	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
space	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
multiple spaces	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
empty string	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
non-integer number	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
integer outside the range	Number<input> out of range. Please type a number between 1 and <range>:	✅
integer from the specified range	You have selected: <dish>	✅

Double-step test cases

Shorthand	Stands for
INT✅	integer from the range
INT❌	integer from outside the range
X	Any other character(s)

Input	Expected answer	Result
X then X	<input> is not a valid number[...] x2	✅
X then INT❌	<input> is not a valid number[...] Number<input> out of range[...]	✅
X then INT✅	<input> is not a valid number[...] You have selected[...]	✅
INT❌ then INT❌	Number<input> out of range[...] x2	✅
INT❌ then X	Number<input> out of range[...] <input> is not a valid number[...]	✅
INT❌ then INT✅	Number<input> out of range[...] You have selected[...]	✅
INT✅ then INT✅	not possible, program continues after 1st input	✅
INT✅ then X	not possible, program continues after 1st input	✅
INT✅ then INT❌	not possible, program continues after 1st input	✅

Float from a range

How many <units> of <ingredient> do you have?

This input method accepts floats that are positive, including 0.

Single-step test cases

Input	Expected answer	Result
letter character	<input> is not a valid number. Please type a number that is 0 or above.	✅
multiple letter characters	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
special character	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
multiple special characters	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
space	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
multiple spaces	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
empty string	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
non-positive number	<input> is not a valid number. Please type a whole number between 1 and <range>.	✅
float from the specified range	Got it, you have <input> <units> of <ingredient>	✅
integer from the specified range	Got it, you have <input> <units> of <ingredient>	✅

Double-step test cases

Shorthand	Stands for
INT✅	integer from the range
INT❌	integer from outside the range
X	Any other character(s)

Input	Expected answer	Result
X then X	<input> is not a valid number[...] x2	✅
X then INT❌	<input> is not a valid number[...] Number<input> out of range[...]	✅
X then INT✅	<input> is not a valid number[...] Got it, you have[...]	✅
INT❌ then INT❌	Number<input> out of range[...] x2	✅
INT❌ then X	Number<input> out of range[...] <input> is not a valid number[...]	✅
INT❌ then INT✅	Number<input> out of range[...] Got it, you have[...]	✅
INT✅ then INT✅	not possible, program continues after 1st input	✅
INT✅ then X	not possible, program continues after 1st input	✅
INT✅ then INT❌	not possible, program continues after 1st input	✅

Flow testing

The summarized program flow is repeated here for convenience:

• if the user answers Y to the initial question: start planning loop
• if the user answers N to the initial question: end with message
• when the user selects a dish:
  • remove it from the list of dishes
  • display its name and ingredients
  • add its ingredients to the shopping list
• if the shopping list already contains an ingredient that is added: combine two items into one, sum the ingredient quantity
• if the user wants to continue adding an ingredient: rerun planning loop
• if the user does not want to add more ingredients:
  • end planning loop
  • ask if they want to check their pantry
• if the user selects all dishes:
  • end planning loop
  • ask if they want to check their pantry
• if the user does not want to check the pantry:
  • print shopping list, end program
• if the user wants to check the pantry
  • ask how much of each shopping list ingredient they have
  • subtract answer from quantity on shopping list
    • if resulting quantity is 0 or less, remove item from the list
• if there are shopping list items left, print shopping list
• end program with message

All events in the flow work as expected.

On the flowchart below, I marked the crucial places in the flow that have been manually tested. The table below the flowchart summarizes the event and the behavior that is expected to follow it, along with the test results.

All events in the flow work as expected.

Nr	Event	expected behavior	Result
1	Input not valid	Error message, new input	✅
2	Input valid	Proceed	✅
3	Input N	End program with message	✅
4	Input Y	Display dishes, start planning loop	✅
5	Input not valid	Error message, new input	✅
6	Input valid	Confirm selection	✅
7	Input valid	Add ingredients to shopping list	✅
8	Ingredients added to shopping list	Unify quantities in shopping list	✅
9	No dishes left	Ask to check pantry	✅
10	Input not valid	Error message, new input	✅
11	Input valid	Proceed	✅
12	Input Y	Display dishes, repeat planning loop	✅
13	Input N	Ask to check pantry	✅
14	Input not valid	Error message, new input	✅
15	Input valid	Proceed	✅
16	Input N	Print shopping list, End program with message	✅
17	Input Y	Start pantry loop, ask quantity of ingredient	✅
18	Input not valid	Error message, new input	✅
19	Input valid	Confirm message, subtract number from shopping list	✅
20	number < 0	remove item from shopping list	✅
21	There are more quantities to check	repeat pantry loop	✅
22	There are no more quantities to check	proceed	✅
23	There are items left on shopping list	Print shopping list, End program with message	✅
24	There are no items left on shopping list	End program with message	✅

Database data validation

The database in Google Sheets was manually checked for the following:

Check	Result
dishes are in the second row	✅
ingredients are in the first column	✅
each ingredient cell contains ( and )	✅
capitalization (none)	✅
spelling	✅
quantity cells only contain floats	✅

Devices & browsers

Devices

The website was tested on the following devices:

• Macbook Air M2, Mac OS Sonoma 14.3.1
• Macbook Air M1, Mac OS Sonoma 14.3.1
• Lenovo Tab M10 (3rd gen)
• Lenovo ThinkPad

Browsers

The site was tested on the following browsers:

• Google Chrome
• Microsoft Edge
• Firefox

Bugs

All bugs are tracked in GitHub Issues.

Known bugs

There are no known bugs in the project.

Solved bugs

Solved bugs are listed in GitHub Issues.