diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..b3ec7d5e1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,220 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[codz] +*$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 +*.lcov +.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 + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# uv.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 +# poetry.toml + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python. +# https://pdm-project.org/en/latest/usage/project/#working-with-version-control +# pdm.lock +# pdm.toml +.pdm-python +.pdm-build/ + +# pixi +# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control. +# pixi.lock +# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one +# in the .venv directory. It is recommended not to include this directory in version control. +.pixi/* +!.pixi/config.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 + +# Redis +*.rdb +*.aof +*.pid + +# RabbitMQ +mnesia/ +rabbitmq/ +rabbitmq-data/ + +# ActiveMQ +activemq-data/ + +# SageMath parsed files +*.sage.py + +# Environments +.env +.envrc +.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/ + +# Abstra +# Abstra is an AI-powered process automation framework. +# Ignore directories containing user credentials, local state, and settings. +# Learn more at https://abstra.io/docs +.abstra/ + +# Visual Studio Code +# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore +# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore +# and can be added to the global gitignore or merged into this file. However, if you prefer, +# you could uncomment the following to ignore the entire vscode folder +# .vscode/ +# Temporary file for partial code execution +tempCodeRunnerFile.py + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + +# Marimo +marimo/_static/ +marimo/_lsp/ +__marimo__/ + +# Streamlit +.streamlit/secrets.toml diff --git a/README.md b/README.md index 272081708..5ad3a4eff 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ ### Реализованные сценарии -Созданы юнит-тесты, покрывающие классы `Bun`, `Burger`, `Ingredient`, `Database` +Созданы юнит-тесты, покрывающие класс `Burger` Процент покрытия 100% (отчет: `htmlcov/index.html`) ### Структура проекта - `praktikum` - пакет, содержащий код программы -- `tests` - пакет, содержащий тесты, разделенные по классам. Например, `bun_test.py`, `burger_test.py` и т.д. +- `tests` - пакет, содержащий тесты, разделенные по классам. Например, `burger_test.py`. ### Запуск автотестов @@ -21,4 +21,4 @@ **Запуск автотестов и создание HTML-отчета о покрытии** -> `$ pytest --cov=praktikum --cov-report=html` +> `$ pytest --cov=praktikum.burger --cov-report=html` diff --git a/conftest.py b/conftest.py new file mode 100644 index 000000000..dcea0571a --- /dev/null +++ b/conftest.py @@ -0,0 +1,31 @@ +import pytest +from unittest.mock import Mock +from praktikum.burger import Burger + + +@pytest.fixture +def burger(): + return Burger() + +@pytest.fixture +def mock_bun(): + mock_bun = Mock() + mock_bun.get_name.return_value = "red bun" + mock_bun.get_price.return_value = 300 + return mock_bun + +@pytest.fixture +def mock_ingredient_1(): + mock_ingredient_1 = Mock() + mock_ingredient_1.get_type.return_value = "FILLING" + mock_ingredient_1.get_name.return_value = "dinosaur" + mock_ingredient_1.get_price.return_value = 200 + return mock_ingredient_1 + +@pytest.fixture +def mock_ingredient_2(): + mock_ingredient_2 = Mock() + mock_ingredient_2.get_type.return_value = "SAUCE" + mock_ingredient_2.get_name.return_value = "hot sauce" + mock_ingredient_2.get_price.return_value = 200 + return mock_ingredient_2 \ No newline at end of file diff --git a/__init__.py b/praktikum/__init__.py similarity index 100% rename from __init__.py rename to praktikum/__init__.py diff --git a/bun.py b/praktikum/bun.py similarity index 100% rename from bun.py rename to praktikum/bun.py diff --git a/burger.py b/praktikum/burger.py similarity index 100% rename from burger.py rename to praktikum/burger.py diff --git a/database.py b/praktikum/database.py similarity index 100% rename from database.py rename to praktikum/database.py diff --git a/ingredient.py b/praktikum/ingredient.py similarity index 100% rename from ingredient.py rename to praktikum/ingredient.py diff --git a/ingredient_types.py b/praktikum/ingredient_types.py similarity index 100% rename from ingredient_types.py rename to praktikum/ingredient_types.py diff --git a/praktikum.py b/praktikum/praktikum.py similarity index 100% rename from praktikum.py rename to praktikum/praktikum.py diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..b6515c14c Binary files /dev/null and b/requirements.txt differ diff --git a/tests/test_burger.py b/tests/test_burger.py new file mode 100644 index 000000000..aafdd8e08 --- /dev/null +++ b/tests/test_burger.py @@ -0,0 +1,75 @@ +import pytest +from praktikum.ingredient import Ingredient + +class TestBurger: + + def test_set_buns_is_success(self, burger, mock_bun): + burger.set_buns(mock_bun) + + assert burger.bun == mock_bun + + def test_add_ingredient_is_success(self, burger, mock_ingredient_1): + burger.add_ingredient(mock_ingredient_1) + + assert mock_ingredient_1 in burger.ingredients + + def test_remove_ingredient_is_success(self, burger, mock_ingredient_1, mock_ingredient_2): + burger.add_ingredient(mock_ingredient_1) + burger.add_ingredient(mock_ingredient_2) + burger.remove_ingredient(0) + + assert burger.ingredients == [mock_ingredient_2] + + @pytest.mark.parametrize( + "index, new_index, expected_indexes", + [ + (0, 1, [1, 0]), + (1, 0, [1, 0]), + (0, 0, [0, 1]), + (1, 1, [0, 1]) + ] + ) + def test_move_ingredient_is_success(self, burger, index, new_index, expected_indexes): + + first_ingredient = Ingredient("FILLING", "dinosaur", 200) + second_ingredient = Ingredient("SAUCE", "hot sauce", 200) + + burger.add_ingredient(first_ingredient) + burger.add_ingredient(second_ingredient) + + ingredients_list = [first_ingredient, second_ingredient] + + burger.move_ingredient(index, new_index) + + expected_order = [ingredients_list[i] for i in expected_indexes] + + assert burger.ingredients == expected_order + + def test_get_price_with_bun_and_ingredients_is_success(self, burger, mock_bun, mock_ingredient_1, mock_ingredient_2): + burger.set_buns(mock_bun) + burger.add_ingredient(mock_ingredient_1) + burger.add_ingredient(mock_ingredient_2) + + expected_cost = mock_bun.get_price.return_value * 2 + expected_cost += mock_ingredient_1.get_price.return_value + mock_ingredient_2.get_price.return_value + + assert burger.get_price() == expected_cost + + + def test_get_receipt_is_success(self, burger, mock_bun, mock_ingredient_1, mock_ingredient_2): + burger.set_buns(mock_bun) + burger.add_ingredient(mock_ingredient_1) + burger.add_ingredient(mock_ingredient_2) + + receipt = burger.get_receipt() + + expected_receipt = ( + '(==== red bun ====)\n' + '= filling dinosaur =\n' + '= sauce hot sauce =\n' + '(==== red bun ====)\n' + '\n' + 'Price: 1000' + ) + + assert receipt == expected_receipt