From d6bc88faa2016c6c67cb7491ad3fa62c46f560bf 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 | 96 +++++++----------------------------
calculator/calculator.py | 3 --
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 -----------
11 files changed, 26 insertions(+), 280 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 0d0cb9f..deecb6a 100644
--- a/README.md
+++ b/README.md
@@ -1,92 +1,32 @@
# CICD 2022
+## TP1
+Pour lancer l'application python:
-## Getting started
-
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-
-```
-cd existing_repo
-git remote add origin https://gitlab.viarezo.fr/ViaRezo/cicd-2022.git
-git branch -M main
-git push -uf origin main
+```bash
+pip install -r requirements.txt
+uvicorn calculator.server:app --reload
```
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.viarezo.fr/ViaRezo/cicd-2022/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+## Le Linting
-***
+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.
-# Editing this README
+Un outil qui permet de vérifier le linting de nos application python, c'est pylint. Pour l'installer, on peut utiliser pip:
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+```bash
+pip install pylint
+```
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+Pour lancer pylint, on peut utiliser la commande suivante:
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+```bash
+pylint calculator
+```
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+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:
-## License
-For open source projects, say how it is licensed.
+```bash
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+Alors on pourrait fixer les erreurs maintenant, mais on va d'abord vérifier une pipeline avec GitLab.
diff --git a/calculator/calculator.py b/calculator/calculator.py
index 1847cd0..0be066d 100644
--- a/calculator/calculator.py
+++ b/calculator/calculator.py
@@ -19,9 +19,6 @@ class Calculator:
self.operators = operators
def tokenize(self, line: str) -> list[Token]:
- """
- Tokenize an expression into a list of tokens.
- """
tokens = []
for token in line.split():
if token in self.operators:
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