github-classroom[bot]
2 years ago
committed by
GitHub
commit
35a9c9319a
11 changed files with 572 additions and 0 deletions
@ -0,0 +1,14 @@
@@ -0,0 +1,14 @@
|
||||
{ |
||||
"tests": [ |
||||
{ |
||||
"name": "Regression", |
||||
"setup": "sudo -H pip3 install poetry ; poetry install", |
||||
"run": "poetry run pytest .", |
||||
"input": "", |
||||
"output": "", |
||||
"comparison": "included", |
||||
"timeout": 5, |
||||
"points": 1 |
||||
} |
||||
] |
||||
} |
||||
@ -0,0 +1,21 @@
@@ -0,0 +1,21 @@
|
||||
name: GitHub Classroom Workflow |
||||
|
||||
on: [push] |
||||
|
||||
jobs: |
||||
build: |
||||
permissions: write-all |
||||
name: Autograding |
||||
strategy: |
||||
fail-fast: false |
||||
matrix: |
||||
python-version: [3.11.0] |
||||
poetry-version: [1.7.0] |
||||
os: [ubuntu-latest] |
||||
runs-on: ${{ matrix.os }} |
||||
steps: |
||||
- uses: actions/checkout@v2 |
||||
- uses: actions/setup-python@v4 |
||||
with: |
||||
python-version: ${{ matrix.python-version }} |
||||
- uses: education/autograding@v1 |
||||
@ -0,0 +1,160 @@
@@ -0,0 +1,160 @@
|
||||
# Byte-compiled / optimized / DLL files |
||||
__pycache__/ |
||||
*.py[cod] |
||||
*$py.class |
||||
|
||||
# C extensions |
||||
*.so |
||||
|
||||
# Distribution / packaging |
||||
.Python |
||||
build/ |
||||
develop-eggs/ |
||||
dist/ |
||||
downloads/ |
||||
eggs/ |
||||
.eggs/ |
||||
lib/ |
||||
lib64/ |
||||
parts/ |
||||
sdist/ |
||||
var/ |
||||
wheels/ |
||||
share/python-wheels/ |
||||
*.egg-info/ |
||||
.installed.cfg |
||||
*.egg |
||||
MANIFEST |
||||
|
||||
# PyInstaller |
||||
# Usually these files are written by a python script from a template |
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it. |
||||
*.manifest |
||||
*.spec |
||||
|
||||
# Installer logs |
||||
pip-log.txt |
||||
pip-delete-this-directory.txt |
||||
|
||||
# Unit test / coverage reports |
||||
htmlcov/ |
||||
.tox/ |
||||
.nox/ |
||||
.coverage |
||||
.coverage.* |
||||
.cache |
||||
nosetests.xml |
||||
coverage.xml |
||||
*.cover |
||||
*.py,cover |
||||
.hypothesis/ |
||||
.pytest_cache/ |
||||
cover/ |
||||
|
||||
# Translations |
||||
*.mo |
||||
*.pot |
||||
|
||||
# Django stuff: |
||||
*.log |
||||
local_settings.py |
||||
db.sqlite3 |
||||
db.sqlite3-journal |
||||
|
||||
# Flask stuff: |
||||
instance/ |
||||
.webassets-cache |
||||
|
||||
# Scrapy stuff: |
||||
.scrapy |
||||
|
||||
# Sphinx documentation |
||||
docs/_build/ |
||||
|
||||
# PyBuilder |
||||
.pybuilder/ |
||||
target/ |
||||
|
||||
# Jupyter Notebook |
||||
.ipynb_checkpoints |
||||
|
||||
# IPython |
||||
profile_default/ |
||||
ipython_config.py |
||||
|
||||
# pyenv |
||||
# For a library or package, you might want to ignore these files since the code is |
||||
# intended to run in multiple environments; otherwise, check them in: |
||||
# .python-version |
||||
|
||||
# pipenv |
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. |
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies |
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not |
||||
# install all needed dependencies. |
||||
#Pipfile.lock |
||||
|
||||
# poetry |
||||
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. |
||||
# This is especially recommended for binary packages to ensure reproducibility, and is more |
||||
# commonly ignored for libraries. |
||||
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control |
||||
#poetry.lock |
||||
|
||||
# pdm |
||||
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. |
||||
#pdm.lock |
||||
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it |
||||
# in version control. |
||||
# https://pdm.fming.dev/#use-with-ide |
||||
.pdm.toml |
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm |
||||
__pypackages__/ |
||||
|
||||
# Celery stuff |
||||
celerybeat-schedule |
||||
celerybeat.pid |
||||
|
||||
# SageMath parsed files |
||||
*.sage.py |
||||
|
||||
# Environments |
||||
.env |
||||
.venv |
||||
env/ |
||||
venv/ |
||||
ENV/ |
||||
env.bak/ |
||||
venv.bak/ |
||||
|
||||
# Spyder project settings |
||||
.spyderproject |
||||
.spyproject |
||||
|
||||
# Rope project settings |
||||
.ropeproject |
||||
|
||||
# mkdocs documentation |
||||
/site |
||||
|
||||
# mypy |
||||
.mypy_cache/ |
||||
.dmypy.json |
||||
dmypy.json |
||||
|
||||
# Pyre type checker |
||||
.pyre/ |
||||
|
||||
# pytype static type analyzer |
||||
.pytype/ |
||||
|
||||
# Cython debug symbols |
||||
cython_debug/ |
||||
|
||||
# PyCharm |
||||
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can |
||||
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore |
||||
# and can be added to the global gitignore or merged into this file. For a more nuclear |
||||
# option (not recommended) you can uncomment the following to ignore the entire idea folder. |
||||
#.idea/ |
||||
@ -0,0 +1,21 @@
@@ -0,0 +1,21 @@
|
||||
MIT License |
||||
|
||||
Copyright (c) 2023 Mark Patterson |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in all |
||||
copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
SOFTWARE. |
||||
@ -0,0 +1,70 @@
@@ -0,0 +1,70 @@
|
||||
# Hangman Game |
||||
|
||||
Python console app hangman game based on the [code](https://github.com/markpatterson27/hangman-game) by [Mark Patterson](https://github.com/markpatterson27) |
||||
|
||||
## Install dependencies and run |
||||
|
||||
1. `pip install poetry` |
||||
2. `poetry install` |
||||
3. `poetry run python app/hangman.py` |
||||
|
||||
# Lab "Test Coverage" Assignment |
||||
|
||||
### Important instructions |
||||
1. do not move/delete the source files from the folders |
||||
1. submission: _commit_ and _push_ your changes to the current project to GitHub |
||||
1. do not edit _autograding_ or _classroom_ files |
||||
> :warning: **Note:** the autograding is simplified on purpose, it will be overwritten after the submission deadline with additional tests and quiz grading |
||||
|
||||
> :warning: **Note:** `app/hangman.py` should not be changed, anyways it will be overwritten in the post processing for the final autograding |
||||
|
||||
> :warning: **Note:** `tests/test_hangman.py` All your tests should be in this file |
||||
|
||||
> :warning: **Note:** `.github/workflows/main.yaml` Your CI pipeline should be in this file |
||||
|
||||
> :warning: **Note:** For the coverage threashold, use the command line only in the pipeline. |
||||
|
||||
## Basis path testing (1pt) |
||||
|
||||
* Calculate the minimum number of the basis path test cases needed for the 'hangman.py::hangman' |
||||
|
||||
* Add the number here between the brackets. |
||||
|
||||
> _Your answer. For example (5):_ |
||||
> |
||||
> **Q1** (__) |
||||
|
||||
## Create test cases (3pt) |
||||
|
||||
* Create test cases with the minimum *85% of combined coverage* (lines and branch coverage) for the whole `hangman.py` |
||||
* Place your tests under the `tests/test_hangman.py` folder |
||||
|
||||
> :warning: **Note:** the `hangman.py` should not be modified. It will be overwriten for in the final autograding stage after the submission deadline. |
||||
|
||||
## Calculate coverage (1pt) |
||||
|
||||
* What is the line coverage of your test suite for the `hangman.py`? |
||||
> _Your answer in %. For example (86):_ |
||||
> |
||||
> **Q2** (__) |
||||
|
||||
* What is the current branch coverage of your test suite for the `hangman.py`? |
||||
> _Your answer in %. For example (86):_ |
||||
> |
||||
> **Q3** (__) |
||||
|
||||
|
||||
## Add CI (1pt) |
||||
* Add `main.yaml` that runs your test suite from `tests/` and has the minimum coverage criteria for the whole `hangman.py` of **85%** for the **combined** coverage (**total** coverage including lines + branches) |
||||
|
||||
> :warning: **Note:** For the coverage threashold, use the command line only in the pipeline. Do not use config files. |
||||
|
||||
# Hints |
||||
* Check the [basis path tutorial](https://www.tutorialspoint.com/path-testing-and-basis-path-testing-with-example) |
||||
* Check the [python testing tutorial](https://testdriven.io/blog/testing-python/) |
||||
|
||||
|
||||
## Spoilers |
||||
* you may need to recall the lab on metrics to get the answer to _Q1_ |
||||
* you may need _pytest-cov_ module installed |
||||
* you may need to generate and check _coverage.json_ to get the raw data and calculate exact numbers for the coverage |
||||
@ -0,0 +1,190 @@
@@ -0,0 +1,190 @@
|
||||
# Console based hangman game. |
||||
|
||||
# DO NOT EDIT. IT WILL BE OVERWRITTEN IN THE FINAL AUTOGRADING AFTER THE SUBMISSION DEADLINE |
||||
|
||||
import random |
||||
import os |
||||
|
||||
# Constants |
||||
WORDS = ("python", "jumble", "easy", "difficult", "answer", "xylophone", "hangman", |
||||
"computer", "science", "programming", "mathematics", "player", "condition", |
||||
"reverse", "water", "board", "geeks", "keyboard", "laptop", "headphone", |
||||
"mouse", "printer", "scanner", "software", "hardware", "network", "server") |
||||
|
||||
HANGMAN_STAGES = ( |
||||
""" |
||||
------- |
||||
|/ | |
||||
| |
||||
| |
||||
| |
||||
| |
||||
| |
||||
/|\\ |
||||
----------- |
||||
""",""" |
||||
------- |
||||
|/ | |
||||
| O |
||||
| |
||||
| |
||||
| |
||||
| |
||||
/|\\ |
||||
----------- |
||||
""",""" |
||||
------- |
||||
|/ | |
||||
| O |
||||
| | |
||||
| |
||||
| |
||||
| |
||||
/|\\ |
||||
----------- |
||||
""",""" |
||||
------- |
||||
|/ | |
||||
| O |
||||
| | |
||||
| | |
||||
| |
||||
| |
||||
/|\\ |
||||
----------- |
||||
""",""" |
||||
------- |
||||
|/ | |
||||
| O |
||||
| /| |
||||
| | |
||||
| |
||||
| |
||||
/|\\ |
||||
----------- |
||||
""",""" |
||||
------- |
||||
|/ | |
||||
| O |
||||
| /|\\ |
||||
| | |
||||
| |
||||
| |
||||
/|\\ |
||||
----------- |
||||
""",""" |
||||
------- |
||||
|/ | |
||||
| O |
||||
| /|\\ |
||||
| | |
||||
| / |
||||
| |
||||
/|\\ |
||||
----------- |
||||
""",""" |
||||
------- |
||||
|/ | |
||||
| O |
||||
| /|\\ |
||||
| | |
||||
| / \\ |
||||
| |
||||
/|\\ |
||||
----------- |
||||
""") |
||||
|
||||
# Functions |
||||
def clear_screen(): |
||||
"""Clears the screen.""" |
||||
os.system("cls" if os.name == "nt" else "clear") |
||||
|
||||
def get_random_word(): |
||||
"""Returns a random word from the WORDS tuple.""" |
||||
return random.choice(WORDS) |
||||
|
||||
def splash_screen(): |
||||
"""The splash screen.""" |
||||
print(""" |
||||
_ _ ----- |
||||
| | | | __ _ _ __ __ _ _ __ ___ __ _ _ __ | o |
||||
| |_| |/ _` | '_ \\ / _` | '_ ` _ \\ / _` | '_ \\ | /|\\ |
||||
| _ | (_| | | | | (_| | | | | | | (_| | | | | | / \\ |
||||
|_| |_|\\__,_|_| |_|\\__, |_| |_| |_|\\__,_|_| |_| | |
||||
|___/ v1.0 |
||||
""") |
||||
input("Press enter to continue...") |
||||
clear_screen() |
||||
|
||||
|
||||
def hangman(): |
||||
"""The hangman game.""" |
||||
try: |
||||
# game outer loop |
||||
while True: |
||||
# Setup |
||||
word = get_random_word() |
||||
guessed_letters = [] |
||||
guessed_word = ["_"] * len(word) |
||||
wrong_guesses = 0 |
||||
|
||||
# game inner loop |
||||
while True: |
||||
clear_screen() |
||||
print("Hangman game. Try to guess the word. (CTRL+C to quit)") |
||||
print(HANGMAN_STAGES[wrong_guesses]) |
||||
print(" ".join(guessed_word), end=' ') |
||||
print("(Guessed letters: " + ", ".join(guessed_letters),")") |
||||
print() |
||||
|
||||
# check if player has won |
||||
if "_" not in guessed_word: |
||||
print("You win!") |
||||
break |
||||
|
||||
# check if player has lost |
||||
if wrong_guesses == len(HANGMAN_STAGES)-1: |
||||
print("You lose!") |
||||
break |
||||
|
||||
# make sure player enters a single letter |
||||
while True: |
||||
guess = input("Guess a letter: ").lower() |
||||
if len(guess) == 1 and guess.isalpha(): |
||||
# check if letter has already been guessed |
||||
if guess in guessed_letters: |
||||
print("You have already guessed that letter.") |
||||
else: |
||||
break |
||||
else: |
||||
print("Invalid guess. Please enter a single letter.") |
||||
|
||||
# add guess to guessed letters |
||||
guessed_letters.append(guess) |
||||
|
||||
# check if guess is in word |
||||
if guess in word: |
||||
# add guess to guessed word |
||||
for i in range(len(word)): |
||||
if word[i] == guess: |
||||
guessed_word[i] = guess |
||||
else: |
||||
# increment wrong guesses |
||||
wrong_guesses += 1 |
||||
|
||||
# Ask the player if they want to play again |
||||
play_again = input("Play again? (y/n): ").lower() |
||||
if play_again != "y": |
||||
break |
||||
|
||||
print("\nGoodbye!") |
||||
|
||||
except KeyboardInterrupt: |
||||
print("\nGoodbye!") |
||||
exit() |
||||
|
||||
|
||||
# Main |
||||
if __name__ == "__main__": |
||||
splash_screen() |
||||
hangman() |
||||
@ -0,0 +1,74 @@
@@ -0,0 +1,74 @@
|
||||
# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. |
||||
|
||||
[[package]] |
||||
name = "colorama" |
||||
version = "0.4.6" |
||||
description = "Cross-platform colored terminal text." |
||||
optional = false |
||||
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" |
||||
files = [ |
||||
{file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, |
||||
{file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, |
||||
] |
||||
|
||||
[[package]] |
||||
name = "iniconfig" |
||||
version = "2.0.0" |
||||
description = "brain-dead simple config-ini parsing" |
||||
optional = false |
||||
python-versions = ">=3.7" |
||||
files = [ |
||||
{file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, |
||||
{file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, |
||||
] |
||||
|
||||
[[package]] |
||||
name = "packaging" |
||||
version = "23.2" |
||||
description = "Core utilities for Python packages" |
||||
optional = false |
||||
python-versions = ">=3.7" |
||||
files = [ |
||||
{file = "packaging-23.2-py3-none-any.whl", hash = "sha256:8c491190033a9af7e1d931d0b5dacc2ef47509b34dd0de67ed209b5203fc88c7"}, |
||||
{file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"}, |
||||
] |
||||
|
||||
[[package]] |
||||
name = "pluggy" |
||||
version = "1.4.0" |
||||
description = "plugin and hook calling mechanisms for python" |
||||
optional = false |
||||
python-versions = ">=3.8" |
||||
files = [ |
||||
{file = "pluggy-1.4.0-py3-none-any.whl", hash = "sha256:7db9f7b503d67d1c5b95f59773ebb58a8c1c288129a88665838012cfb07b8981"}, |
||||
{file = "pluggy-1.4.0.tar.gz", hash = "sha256:8c85c2876142a764e5b7548e7d9a0e0ddb46f5185161049a79b7e974454223be"}, |
||||
] |
||||
|
||||
[package.extras] |
||||
dev = ["pre-commit", "tox"] |
||||
testing = ["pytest", "pytest-benchmark"] |
||||
|
||||
[[package]] |
||||
name = "pytest" |
||||
version = "8.0.0" |
||||
description = "pytest: simple powerful testing with Python" |
||||
optional = false |
||||
python-versions = ">=3.8" |
||||
files = [ |
||||
{file = "pytest-8.0.0-py3-none-any.whl", hash = "sha256:50fb9cbe836c3f20f0dfa99c565201fb75dc54c8d76373cd1bde06b06657bdb6"}, |
||||
{file = "pytest-8.0.0.tar.gz", hash = "sha256:249b1b0864530ba251b7438274c4d251c58d868edaaec8762893ad4a0d71c36c"}, |
||||
] |
||||
|
||||
[package.dependencies] |
||||
colorama = {version = "*", markers = "sys_platform == \"win32\""} |
||||
iniconfig = "*" |
||||
packaging = "*" |
||||
pluggy = ">=1.3.0,<2.0" |
||||
|
||||
[package.extras] |
||||
testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"] |
||||
|
||||
[metadata] |
||||
lock-version = "2.0" |
||||
python-versions = "^3.11" |
||||
content-hash = "b439de7b0c1dcc9846389b7d06c9d856f9f0b7eedcfdf44f2c335d4b4aed0ed1" |
||||
@ -0,0 +1,15 @@
@@ -0,0 +1,15 @@
|
||||
[tool.poetry] |
||||
name = "project-hangman-game" |
||||
version = "0.1.0" |
||||
description = "" |
||||
authors = ["Your Name <you@example.com>"] |
||||
readme = "README.md" |
||||
|
||||
[tool.poetry.dependencies] |
||||
python = "^3.11" |
||||
pytest = "^8.0.0" |
||||
|
||||
|
||||
[build-system] |
||||
requires = ["poetry-core"] |
||||
build-backend = "poetry.core.masonry.api" |
||||
Loading…
Reference in new issue