OpenClassrooms-Student-Center · loutreceleste · Mar 26, 2024 · Mar 27, 2024 · Mar 28, 2024 · Mar 28, 2024
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,2 @@
+.git
+.env
diff --git a/.github/workflows/oc_lettings.yml b/.github/workflows/oc_lettings.yml
@@ -0,0 +1,105 @@
+name: GitHub Actions Integration
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  compilations_and_tests:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install Python and dependencies
+        run: |
+          sudo apt update
+          sudo apt install python3-pip
+          pip3 install -r requirements.txt
+          pip3 install pytest pytest-cov
+
+      - name: Set up environment variables
+        env:
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+          SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+        run: |
+          echo "SECRET_KEY=$SECRET_KEY" >> $GITHUB_ENV
+          echo "SENTRY_DSN=$SENTRY_DSN" >> $GITHUB_ENV
+
+      - name: Run Tests whit Coverage
+        run: pytest
+
+      - name: Run Linting
+        run: flake8
+
+  containerization_and_push:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    needs: compilations_and_tests
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Build Docker image to ECR and DockerHub
+        run: |
+          cd $(git rev-parse --show-toplevel) && COMMIT_HASH=$(git rev-parse --short HEAD)
+          docker build -t python-oc-lettings-fr:$COMMIT_HASH -f Dockerfile .
+
+      - name: Push Docker image to ECR
+        run: |
+          cd $(git rev-parse --show-toplevel) && COMMIT_HASH=$(git rev-parse --short HEAD)
+          aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin $ECR_URL_REPOSITORY
+          docker tag python-oc-lettings-fr:$COMMIT_HASH $ECR_URL_REPOSITORY:$COMMIT_HASH
+          docker push $ECR_URL_REPOSITORY:$COMMIT_HASH
+        env:
+          ECR_URL_REPOSITORY: ${{ secrets.ECR_URL_REPOSITORY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
+
+      - name: Push Docker image to DockerHub and to local
+        run: |
+          cd $(git rev-parse --show-toplevel) && COMMIT_HASH=$(git rev-parse --short HEAD)
+          echo "$DOCKERHUB_PASSWORD" | docker login -u $DOCKERHUB_USERNAME --password-stdin
+          docker tag python-oc-lettings-fr:$COMMIT_HASH $DOCKERHUB_USERNAME/python-oc-lettings-fr:$COMMIT_HASH
+          docker push $DOCKERHUB_USERNAME/python-oc-lettings-fr:$COMMIT_HASH
+        env:
+          DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+  build:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    needs: containerization_and_push
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up AWS credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+
+      - name: Update ECS Task Definition
+        run: |
+          cd $(git rev-parse --show-toplevel) && COMMIT_HASH=$(git rev-parse --short HEAD)
+          TASK_DEFINITION=$(aws ecs describe-task-definition --task-definition lettings-oc-docker --region $AWS_REGION)
+          NEW_TASK_DEFINITION=$(echo "$TASK_DEFINITION" | jq --arg IMAGE $ECR_URL_REPOSITORY:$COMMIT_HASH '.taskDefinition | .containerDefinitions[0].image = $IMAGE | del(.taskDefinitionArn) | del(.revision) | del(.status) | del(.requiresAttributes) | del(.compatibilities) |  del(.registeredAt) | del(.registeredBy)')
+          NEW_TASK_INFO=$(aws ecs register-task-definition --region $AWS_REGION --cli-input-json "$NEW_TASK_DEFINITION")
+          NEW_REVISION=$(echo $NEW_TASK_INFO | jq '.taskDefinition.revision')
+          aws ecs update-service --cluster lettings-fr --service python-oc-lettings-fr --task-definition lettings-oc-docker:$NEW_REVISION --force-new-deployment --region $AWS_REGION
+        env:
+          ECR_URL_REPOSITORY: ${{ secrets.ECR_URL_REPOSITORY }}
+          AWS_REGION: ${{ secrets.AWS_REGION }}
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,9 @@
 **/__pycache__
 *.pyc
 venv
+.idea/
+.flake8
+.env
+.coverage
+.coveragerc
+htmlcov/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+  - requirements: docs/requirements.txt
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,13 @@
+FROM python:3.10
+
+WORKDIR /app
+
+COPY requirements.txt .
+
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+EXPOSE 8000
+
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
diff --git a/README.md b/README.md
@@ -75,3 +75,57 @@ Utilisation de PowerShell, comme ci-dessus sauf :
 
 - Pour activer l'environnement virtuel, `.\venv\Scripts\Activate.ps1` 
 - Remplacer `which <my-command>` par `(Get-Command <my-command>).Path`
+
+### Déploiement
+
+Ce projet utilise GitHub Actions pour automatiser le déploiement de l'application sur ECS
+
+#### Fonctionnement du déploiement
+
+1. Lorsqu'un push est créé sur n'importe quelle branche, les jobs suivants sont déclenchées :
+  - compilations_and_tests : compile et teste le code.
+2. Lorsqu'une pull request est créée sur la branche master, les jobs suivants sont déclenchés :
+  - compilations_and_tests : compile et teste le code.
+  - containerization_and_push : construit une image Docker, puis la pousse vers ECR et DockerHub.
+  - build : met à jour la tâche ECS avec la nouvelle image Docker et déploie l'application mise à jour.
+
+#### Configuration requise
+
+Pour que le déploiement fonctionne correctement, vous devez disposer des éléments suivants :
+
+1. Un compte AWS avec les autorisations pour Amazon ECS et Amazon ECR.
+2. Un compte Docker Hub pour stocker les images Docker.
+3. Les secrets GitHub :
+- AWS_ACCESS_KEY_ID : votre clé d'accès AWS.
+- AWS_SECRET_ACCESS_KEY : votre clé secrète AWS. 
+- ECR_URL_REPOSITORY: l'url' de votre repository sur ECR.
+- AWS_REGION: la region associé a votre compte AWS.
+- DOCKERHUB_PASSWORD : le mot de passe de votre compte Docker Hub.
+- DOCKERHUB_USERNAME : l'identifiant de votre compte Docker Hub.
+4. Un cluster Amazon ECS avec un service comprenant la définition de tâche lettings-oc-docker.
+
+#### Étapes de déploiement
+
+1. Assurez-vous davoir la configuration requise.
+2. Créez une nouvelle branche à partir de la branche main.
+3. Apportez les modifications souhaitées au code et validez-les dans votre nouvelle branche.
+4. Créez une pull request à partir de votre branche vers la branche master.
+5. Attendez que les GitHub Actions se terminent et vérifiez que le déploiement a réussi.
+6. Une fois le déploiement réussi, vous pouvez fusionner la pull request dans la branche main.
+
+#### Commande unique de déploiement
+Pour déployer votre site en une seule commande, suivez les étapes suivantes :
+
+1. Assurez-vous de vous trouver dans le dossier racine du projet.
+2. Assurez-vous de posséder un compte Docker Hub.
+3. Tapez la commande suivante dans le terminal : `./deploy.sh`
+
+Cette commande construira une image Docker de votre site avec le tag du hash du commit actuel, la poussera vers votre compte Docker Hub et la tirera localement pour que vous puissiez exécuter le site en utilisant l'image Docker.
+
+Vous disposez maintenant dans votre Docker Hub et localement de l'image de votre site actuel.
+
+### Documentation
+
+Une documentation complète est disponible via cette URL unique :
+
+https://python-oc-lettings-fr-loutreceleste.readthedocs.io/en/latest/
diff --git a/deploy.sh b/deploy.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+
+deploy_docker() {
+  cd $(git rev-parse --show-toplevel) && COMMIT_HASH=$(git rev-parse --short HEAD)
+  export DOCKER_USERNAME="$1"
+  export DOCKER_PASSWORD="$2"
+  docker build -t python-oc-lettings-fr:$COMMIT_HASH -f Dockerfile .
+  docker login -u "$DOCKER_USERNAME" -p "$DOCKER_PASSWORD"
+  docker push $DOCKER_USERNAME/python-oc-lettings-fr:$COMMIT_HASH
+  docker pull $DOCKER_USERNAME/python-oc-lettings-fr:$COMMIT_HASH
+}
+
+echo "Entrez votre nom d'utilisateur Docker : "
+read DOCKER_USERNAME
+echo "Entrez votre mot de passe Docker : "
+read -s DOCKER_PASSWORD
+
+deploy_docker "$DOCKER_USERNAME" "$DOCKER_PASSWORD"
+
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/oc_lettings_site/migrations/__init__.py → docs/__init__.py b/oc_lettings_site/migrations/__init__.py → docs/__init__.py
diff --git a/docs/_build/doctrees/database_structure.doctree b/docs/_build/doctrees/database_structure.doctree
diff --git a/docs/_build/doctrees/deployment_managment_procedures.doctree b/docs/_build/doctrees/deployment_managment_procedures.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/instructions_installing_project.doctree b/docs/_build/doctrees/instructions_installing_project.doctree
diff --git a/docs/_build/doctrees/programming_interfaces.doctree b/docs/_build/doctrees/programming_interfaces.doctree
diff --git a/docs/_build/doctrees/project_description.doctree b/docs/_build/doctrees/project_description.doctree
diff --git a/docs/_build/doctrees/quick_start_guide.doctree b/docs/_build/doctrees/quick_start_guide.doctree
diff --git a/docs/_build/doctrees/technologies_programming_use.doctree b/docs/_build/doctrees/technologies_programming_use.doctree
diff --git a/docs/_build/doctrees/user_guide.doctree b/docs/_build/doctrees/user_guide.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: d977518e12d753cf3cca7067ad1a5d36
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -0,0 +1,104 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; OC-Lettings-FR  documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            OC-Lettings-FR
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../modules.html">Python-OC-Lettings-FR</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">OC-Lettings-FR</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="lettings/apps.html">lettings.apps</a></li>
+<li><a href="profiles/apps.html">profiles.apps</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Guy King / Loutreceleste.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>