From 872586f6c247afdb7a39a32add847368cced96b1 Mon Sep 17 00:00:00 2001
From: Florentin Labelle <florentin.labelle@student-cs.fr>
Date: Wed, 12 Oct 2022 14:09:15 +0200
Subject: [PATCH] Setup tp1
---
.gitlab-ci.yml | 31 ++-----------------
README.md | 32 ++++++++++++++-----
calculator/expression.py | 5 +--
calculator/operators.py | 14 +++------
calculator/server.py | 5 +--
calculator/test_calculator.py | 58 -----------------------------------
calculator/test_expression.py | 38 -----------------------
calculator/test_operators.py | 13 --------
deploy/calculator.service | 12 --------
deploy/setup.md | 31 -------------------
10 files changed, 33 insertions(+), 206 deletions(-)
delete mode 100644 calculator/test_calculator.py
delete mode 100644 calculator/test_expression.py
delete mode 100644 calculator/test_operators.py
delete mode 100644 deploy/calculator.service
delete mode 100644 deploy/setup.md
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 64cbc55..278f7bc 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -3,8 +3,6 @@ image: python:3.10
stages:
- dependencies
- lint
- - test
- - deploy
download_dependencies:
stage: dependencies
@@ -21,33 +19,8 @@ pylint:
stage: lint
dependencies:
- download_dependencies
- needs:
- - download_dependencies
before_script:
- source .venv/bin/activate
- - pip install pylint
script:
- - pylint calculator --fail-on=error
-
-pytest:
- stage: test
- dependencies:
- - download_dependencies
- needs:
- - download_dependencies
- before_script:
- - source .venv/bin/activate
- script:
- - pytest calculator
-
-# deploy:
-# stage: deploy
-# needs:
-# - pylint
-# - pytest
-# before_script:
-# - apt-get update
-# - apt-get install -y openssh-client sshpass
-# script:
-# - sshpass -p viazero ssh -o StrictHostKeyChecking=no viazero@<ip-de-ma-vm>
-# "cd /var/www/cicd && git pull && sudo systemctl restart calculator"
+ # C'est à ton tour de coder un script qui lance pylint sur ton projet
+ -
diff --git a/README.md b/README.md
index 18b65f4..deecb6a 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,32 @@
# CICD 2022
-Bienvenue à cette fabuleuse formation.
+## TP1
-Je t'invite à forker le repo et à cloner ton fork sur ta machine.
+Pour lancer l'application python:
-## Le sujet du tp
+```bash
+pip install -r requirements.txt
+uvicorn calculator.server:app --reload
+```
-Le sujet du tp est de proprifier et tester le code d'une calculatrice en ligne. Une simple page web où on peut entrer une expression mathématique et qui nous donne le résultat.
+## Le Linting
-## Pour commencer les tps
+Lorsqu'on travaille en équipe, c'est souvent pratique de garder un code propre. Pour cela, on utilise des outils de linting. Ces outils vont vérifier que le code respecte certaines règles de style. Par exemple, on peut vérifier que les variables sont nommées en snake_case, que les fonctions sont nommées en camelCase, que les fonctions ne font pas plus de 10 lignes, etc.
-Les branches `tp1`, `tp2`, `tp3` contiennent les fichiers de base pour chaque tp.
-La correction sont dans les branches `tp1-correction`, `tp2-correction`.
+Un outil qui permet de vérifier le linting de nos application python, c'est pylint. Pour l'installer, on peut utiliser pip:
+
+```bash
+pip install pylint
+```
+
+Pour lancer pylint, on peut utiliser la commande suivante:
+
+```bash
+pylint calculator
+```
+
+Une option intéressante de pylint est le `--fail-on=warning`. Cette option permet de renvoyer une erreur si pylint détecte une erreur. On peut donc l'ajouter à la commande précédente:
+
+```bash
+
+Alors on pourrait fixer les erreurs maintenant, mais on va d'abord vérifier une pipeline avec GitLab.
diff --git a/calculator/expression.py b/calculator/expression.py
index d796722..1a27f0c 100644
--- a/calculator/expression.py
+++ b/calculator/expression.py
@@ -1,9 +1,8 @@
"""
Expression module defines the structure of an expression.
"""
-from typing import Union
from calculator.operators import Operator
-
+from typing import Union
Term: type = int
Token: type = Union[Operator, Term]
@@ -13,7 +12,6 @@ class OperatorExpression:
"""
OperatorExpression class is an expression that contains an operator and two sub-expressions.
"""
-
def __init__(self, operator: Operator, left, right):
self.operator = operator
self.left = left
@@ -30,7 +28,6 @@ class TermExpression:
"""
TermExpression class is an expression that contains a single term.
"""
-
def __init__(self, value: Term):
self.value = value
diff --git a/calculator/operators.py b/calculator/operators.py
index 8da0d85..f855332 100644
--- a/calculator/operators.py
+++ b/calculator/operators.py
@@ -5,11 +5,10 @@ class Operator:
"""
Operator class is a binary operator with a symbol, a precedence and an evaluation function.
"""
-
def __init__(self, symbol, precedence, evaluate_function):
- self.symbol = symbol
- self.precedence = precedence
- self.evaluate_function = evaluate_function
+ self.symbol = symbol
+ self.precedence = precedence
+ self.evaluate_function = evaluate_function
def __repr__(self):
return self.symbol
@@ -18,9 +17,4 @@ class Operator:
return self.evaluate_function(left, right)
-STANDARD_OPERATORS = {
- '+': Operator('+', 1, lambda a, b: a + b),
- '-': Operator('-', 1, lambda a, b: a - b),
- '*': Operator('×', 2, lambda a, b: a * b),
- '/': Operator('/', 2, lambda a, b: a / b),
-}
+STANDARD_OPERATORS = { '+': Operator('+', 1, lambda a, b: a + b),'-': Operator('-', 1, lambda a, b: a - b),'*': Operator('×', 2, lambda a, b: a * b),'/': Operator('/', 2, lambda a, b: a / b)}
diff --git a/calculator/server.py b/calculator/server.py
index 6d40239..e0dc49a 100644
--- a/calculator/server.py
+++ b/calculator/server.py
@@ -1,10 +1,7 @@
-"""
-Server module for the web calculator.
-"""
+from calculator.calculator import Calculator
from fastapi import FastAPI
from fastapi.requests import Request
from fastapi.templating import Jinja2Templates
-from calculator.calculator import Calculator
app = FastAPI()
templates = Jinja2Templates(directory="calculator/templates")
diff --git a/calculator/test_calculator.py b/calculator/test_calculator.py
deleted file mode 100644
index a7a07e2..0000000
--- a/calculator/test_calculator.py
+++ /dev/null
@@ -1,58 +0,0 @@
-"""
-Test module for the calculator module.
-"""
-import pytest
-from calculator.calculator import Calculator
-from calculator.operators import Operator
-
-
-@pytest.fixture(scope="module", name="setup")
-def fixture_setup():
- """
- Setup the test suite, by instantiating the calculator and the operators.
- """
- plus = Operator('+', 1, lambda a, b: a + b)
- minus = Operator('-', 1, lambda a, b: a - b)
- times = Operator('*', 2, lambda a, b: a * b)
- divide = Operator('/', 2, lambda a, b: a / b)
- calculator = Calculator(
- operators={'+': plus, '-': minus, '*': times, '/': divide})
- yield plus, minus, times, divide, calculator
-
-
-def test_tokenizer(setup):
- """
- Test the tokenizer.
- """
- plus, minus, times, divide, calc = setup
- assert calc.tokenize("1 + 2") == [1, plus, 2]
- assert calc.tokenize("1 + 2 * 3") == [1, plus, 2, times, 3]
- assert calc.tokenize(
- "1 + 2 * 3 / 4") == [1, plus, 2, times, 3, divide, 4]
- assert calc.tokenize(
- "1 + 2 * 3 / 4 - 5") == [1, plus, 2, times, 3, divide, 4, minus, 5]
-
-
-def test_parser(setup):
- """
- Test the parser.
- """
- _, _, _, _, calc = setup
- assert repr(calc.parse(calc.tokenize("1 + 2"))) == '(1 + 2)'
- assert repr(calc.parse(calc.tokenize("1 + 2 * 3"))
- ) == '(1 + (2 * 3))'
- assert repr(calc.parse(calc.tokenize(
- "1 + 2 * 3 / 4"))) == '(1 + ((2 * 3) / 4))'
- assert repr(calc.parse(calc.tokenize(
- "1 + 2 * 3 / 4 - 5"))) == '((1 + ((2 * 3) / 4)) - 5)'
-
-
-def test_evaluation(setup):
- """
- Test the evaluation.
- """
- _, _, _, _, calc = setup
- assert calc("1 + 2") == 3
- assert calc("1 + 2 * 3") == 7
- assert calc("1 + 2 * 3 / 4") == 2.5
- assert calc("1 + 2 * 3 / 4 - 5") == -2.5
diff --git a/calculator/test_expression.py b/calculator/test_expression.py
deleted file mode 100644
index 04b9683..0000000
--- a/calculator/test_expression.py
+++ /dev/null
@@ -1,38 +0,0 @@
-"""
-Test module for expression module.
-"""
-from calculator.expression import TermExpression, OperatorExpression
-from calculator.operators import Operator
-
-def test_single_term():
- """
- Test the TermExpression class.
- """
- expression = TermExpression(42)
- assert repr(expression) == '42'
- assert expression() == 42
-
-
-def test_single_operator():
- """
- Test the OperatorExpression class.
- """
- add = Operator('+', 1, lambda a, b: a + b)
- expression = OperatorExpression(add, TermExpression(1), TermExpression(2))
- assert repr(expression) == '(1 + 2)'
- assert expression() == 3
-
-
-def test_complex_expression():
- """
- Test a complex expression.
- """
- add = Operator('+', 1, lambda a, b: a + b)
- multiply = Operator('*', 2, lambda a, b: a * b)
- expression = OperatorExpression(
- multiply,
- OperatorExpression(add, TermExpression(1), TermExpression(2)),
- TermExpression(3)
- )
- assert repr(expression) == '((1 + 2) * 3)'
- assert expression() == 9
diff --git a/calculator/test_operators.py b/calculator/test_operators.py
deleted file mode 100644
index 657a721..0000000
--- a/calculator/test_operators.py
+++ /dev/null
@@ -1,13 +0,0 @@
-"""
-Test module for the operator module.
-"""
-from calculator.operators import Operator
-
-
-def test_operator():
- """
- Test the Operator class.
- """
- modulo = Operator('%', 1, lambda a, b: a % b)
- assert repr(modulo) == '%'
- assert modulo(15, 4) == 3
diff --git a/deploy/calculator.service b/deploy/calculator.service
deleted file mode 100644
index 49221fe..0000000
--- a/deploy/calculator.service
+++ /dev/null
@@ -1,12 +0,0 @@
-Description=CiCd.
-After=network.target
-StartLimitIntervalSec=0
-
-[Service]
-Type=simple
-ExecStart=python3 -m uvicorn calculator.server:app --port 80 --host 0.0.0.0
-User=root
-WorkingDirectory=/var/www/cicd
-
-[Install]
-WantedBy=multi-user.target
diff --git a/deploy/setup.md b/deploy/setup.md
deleted file mode 100644
index 83e5287..0000000
--- a/deploy/setup.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# Setup la vm pour notre calculatrice
-
-## Clone le repo
-
-```bash
-mkdir -p /var/www
-cd /var/www
-git clone https://gitlab.viarezo.fr/<login>/cicd.git
-```
-
-## Installe les dépendances
-
-```bash
-cd cicd
-pip install -r requirements.txt
-```
-
-## Ajoute le service
-
-Un service c'est une application qui tourne en tâche de fond sur la machine. On va créer un service pour notre application. Un service est un fichier qui se trouve dans `/etc/systemd/system/` et qui s'appelle `quelquechose.service`. On a déjà crée le fichier pour vous, vous n'avez plus qu'à le copier dans le bon dossier.
-
-```bash
-sudo cp deploy/calculator.service /etc/systemd/system/
-sudo systemctl daemon-reload
-sudo systemctl enable calculator
-sudo systemctl start calculator
-```
-
-## Dans ton navigateur
-
-- "http://ip-de-la-vm/"
--
GitLab