initial commit

Author: loicsantschi01

Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.9
+
+WORKDIR /code
+
+COPY ./setup.py /code/setup.py
+
+COPY ./requirements.txt /code/requirements.txt
+
+COPY ./README.md /code/README.md
+
+COPY ./src /code/src
+
+RUN pip install /code
+
+COPY ./controller /code/controller
+
+CMD ["uvicorn", "controller.controller:app", "--host", "0.0.0.0", "--port", "80"]

README.md

@@ -0,0 +1 @@
+# TP2

controller/__init__.py

@@ -0,0 +1,32 @@
+"""
+Fast API controller to query the module
+
+
+"""
+from fastapi import FastAPI
+from src.wallet import Wallet
+
+app = FastAPI()
+
+
+@app.get("/")
+async def get_module():
+    """
+    Query module
+    """
+    return {
+        "module": {
+            "name": "TP2",
+            "description": "Un exercice sur le CI/CD",
+            "version": "1.0",
+        }
+    }
+
+
+@app.get("/wallet-with-100")
+async def get_wallet():
+    """
+    Query module
+    """
+    wallet = Wallet(100)
+    return {"balance": wallet.balance}

controller/controller.py

@@ -0,0 +1,6 @@
+pre-commit==2.20.0
+pytest==7.2.0
+pytest-cov==4.0.0
+coverage==7.0.5
+fastapi==0.92.0
+uvicorn==0.20.0

instructions.md

@@ -0,0 +1,11 @@
+from setuptools import find_packages, setup
+
+setup(
+    name="TP2",
+    version="0.1.0",
+    description="Travail pratique sur la qualité de code et le CI/CD",
+    long_description=open("README.md").read(),
+    author="prenom.nom",
+    package_dir={"TP2": "src"},
+    install_requires=open("requirements.txt").readlines(),
+)

instructions.pdf

@@ -0,0 +1,32 @@
+"""Module that lets you manipulate a wallet"""
+
+
+class InsufficientAmount(Exception):
+    """Exception triggered when you try to spend more money than a wallet has"""
+
+    pass
+
+
+class Wallet(object):
+    """Wallet class that lets your create a Wallet and add or spend money"""
+
+    def __init__(self, initial_amount=0):
+        self.balance = initial_amount
+
+    def spend_cash(self, amount, deferred=False):
+        """Removes the specified amount of money from the current Wallet object"""
+        if self.balance < amount:
+            raise InsufficientAmount(f"Not enough available to spend {amount}")
+
+        self.balance -= amount
+
+    def add_cash(self, amount):
+        """Adds the specified amount of money to the current Wallet object"""
+        self.balance += amount
+
+    def spend_money(self, amount, deferred=False):
+        """Removes the specified amount of money from the current Wallet object"""
+        if self.balance < amount:
+            raise InsufficientAmount(f"Not enough available to spend {amount}")
+
+        self.balance -= amount

requirements.txt

@@ -0,0 +1,10 @@
+# import depuis les sources
+from src.wallet import Wallet
+
+# import depuis le .whl TP2
+# from TP2.wallet import Wallet
+
+if __name__ == "__main__":
+    my_wallet = Wallet(100)
+    my_wallet.add_cash(120)
+    print("Congratulations. You successfully installed the TP2 package !")

setup.py

@@ -0,0 +1,21 @@
+"""Necessary fixtures to test the wallet.py package"""
+import pytest
+from src.wallet import Wallet
+
+# Wallet Fixtures
+@pytest.fixture
+def empty_wallet():
+    """Returns a Wallet instance with a zero balance"""
+    return Wallet()
+
+
+@pytest.fixture
+def wallet():
+    """Returns a Wallet instance with a balance of 20"""
+    return Wallet(20)
+
+
+@pytest.fixture
+def wallet_with_50_balance():
+    """Returns a Wallet instance with a balance  of 50"""
+    return Wallet(50)

src/__init__.py

@@ -0,0 +1,34 @@
+"""
+Unit tests for wallet.py package
+"""
+import pytest
+from src.wallet import Wallet, InsufficientAmount
+from tests.fixtures.wallet_fixtures import empty_wallet, wallet
+
+
+def test_default_initial_amount(empty_wallet):
+    """Tests that initial balance of empty_wallet is 0"""
+    assert empty_wallet.balance == 0
+
+
+def test_setting_initial_amount(wallet):
+    """Tests that initial ballance of wallet is 20"""
+    assert wallet.balance == 20
+
+
+def test_wallet_add_cash(wallet):
+    """Tests add_cash funciton"""
+    wallet.add_cash(80)
+    assert wallet.balance == 100
+
+
+def test_wallet_spend_cash(wallet):
+    """Tests spend_cash function"""
+    wallet.spend_cash(10)
+    assert wallet.balance == 10
+
+
+def test_wallet_spend_cash_raises_exception_on_insufficient_amount(empty_wallet):
+    """Tests that InsufficientAmount exception is raised when trying to spend more thant the wallet's balance"""
+    with pytest.raises(InsufficientAmount):
+        empty_wallet.spend_cash(100)