Milestone 4

.github/workflows/CodeAnalysisCI.yml

@@ -0,0 +1,77 @@
+name: Static_code_analysis
+
+on:
+  push:
+    branches: [ "main", "develop" ]
+  pull_request:
+    branches: [ "main", "develop" ]
+  workflow_dispatch:
+permissions:
+  pull-requests: read # allows SonarCloud to decorate PRs with analysis results
+
+
+jobs:
+  black_test:
+    name: Black Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses : actions/checkout@v3
+      - uses: ./.github/actions/dependencies
+      - name: Run Black Test
+        run: poetry run black . --line-length=79 --check
+  pycodestyle_test:
+    name: Pycodestyle Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses : actions/checkout@v3
+      - uses: ./.github/actions/dependencies
+      - name: Run Pycodestyle Test
+        run: poetry run pycodestyle . --ignore=E501
+  pyright_test:
+    name: Pyright Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses : actions/checkout@v3
+      - uses: ./.github/actions/dependencies
+      - name: Run Pyright Test
+        run: poetry run pyright .
+  unit_test_and_sonar_cloud_report:
+    name: Unit Test and SonarCloud Test
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ secrets.DATABASE_PASS }}
+          MYSQL_DATABASE: answerking_app
+        ports: [ '3306:3306' ]
+    env:
+      DATABASE_NAME: answerking_app
+      DATABASE_USER: ${{ secrets.DATABASE_USER }}
+      DATABASE_PASS: ${{ secrets.DATABASE_PASS }}
+      DATABASE_HOST: 127.0.0.1
+      DATABASE_PORT: 3306
+      DATABASE_ENGINE: django.db.backends.mysql
+      SECRET_KEY: ${{ secrets.SECRET_KEY }}
+      DJANGO_SETTINGS_MODULE: answerking.settings.development
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}   # Generate a token on Sonarcloud.io, add it to the secrets of this repo with the name SONAR_TOKEN (Settings > Secrets > Actions > add new repository secret)
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: ./.github/actions/dependencies
+      - name: Run Migrations
+        run: poetry run python manage.py migrate
+      - name: Run Unit Tests
+        run: poetry run python manage.py test answerking_app.tests.test_unit
+      - name: generate coverage tests
+        run: poetry run coverage run manage.py test --noinput
+      - name: generate report
+        run: poetry run coverage xml
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        with:
+          args: >
+            -Dsonar.python.coverage.reportPaths=coverage.xml
+            -Dsonar.exclusions=answerking_app/tests/**

.github/workflows/IntegrationCI.yml

@@ -0,0 +1,35 @@
+name: Integration Test
+
+on:
+  push:
+    branches: [ "main", "develop" ]
+  pull_request:
+    branches: [ "main", "develop" ]
+  workflow_dispatch:
+
+jobs:
+  integration_tests:
+    name: Integration Test
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ secrets.DATABASE_PASS }}
+          MYSQL_DATABASE: answerking_app
+        ports: [ '3306:3306' ]
+    env:
+      DATABASE_NAME: answerking_app
+      DATABASE_USER: ${{ secrets.DATABASE_USER }}
+      DATABASE_PASS: ${{ secrets.DATABASE_PASS }}
+      DATABASE_HOST: 127.0.0.1
+      DATABASE_PORT: 3306
+      DATABASE_ENGINE: django.db.backends.mysql
+      SECRET_KEY: ${{ secrets.SECRET_KEY }}
+      DJANGO_SETTINGS_MODULE: answerking.settings.development
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/dependencies
+      - name: Run Integration Tests
+        run: poetry run python manage.py test answerking_app.tests.test_integration

.github/workflows/deploy.yml

@@ -0,0 +1,71 @@
+name: Build and deploy
+
+on:
+  push:
+    branches: [ "release-*"]
+
+env:
+  AWS_REGION: eu-west-2
+  ECS_SERVICE: ak-python-ecs-service
+  ECS_CLUSTER: ak-python-ecs-cluster
+  ECS_TASK_DEFINITION: task-definition.json
+  CONTAINER_NAME: ak-python-container
+
+
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    permissions:
+          contents: read
+          packages: write
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Configure AWS credentials
+      uses: aws-actions/configure-aws-credentials@v1
+      with:
+        aws-access-key-id: ${{ secrets.PYTHON_TEST_ACCESS_KEY }}
+        aws-secret-access-key: ${{ secrets.PYTHON_TEST_SECRET_KEY }}
+        aws-region: eu-west-2
+
+    - name: Login to Amazon ECR
+      id: login-ecr
+      uses: aws-actions/amazon-ecr-login@v1
+
+    - name: Build, tag, and push image to Amazon ECR
+      id: build-image
+      env:
+        ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+        ECR_REPOSITORY: ${{ secrets.PYTHON_REPO_NAME }}
+        IMAGE_TAG: latest
+      run: |
+        # Build a docker container and
+        # push it to ECR so that it can
+        # be deployed to ECS.
+        docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
+        docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
+        echo "image=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG" >> $GITHUB_OUTPUT
+
+    - name: Download task definition
+      run: |
+        aws ecs describe-task-definition --task-definition ak-python-task --query taskDefinition > ${{ env.ECS_TASK_DEFINITION }}
+
+    - name: Fill in the new image ID in the Amazon ECS task definition
+      id: task-def
+      uses: aws-actions/amazon-ecs-render-task-definition@v1
+      with:
+        task-definition: ${{ env.ECS_TASK_DEFINITION }}
+        container-name: ${{ env.CONTAINER_NAME }}
+        image: ${{ steps.build-image.outputs.image }}
+
+    - name: Deploy Amazon ECS task definition
+      uses: aws-actions/amazon-ecs-deploy-task-definition@v1
+      with:
+        task-definition: ${{ env.ECS_TASK_DEFINITION }}
+        service: ${{ env.ECS_SERVICE }}
+        cluster: ${{ env.ECS_CLUSTER }}
+        wait-for-service-stability: true

.github/workflows/docker.yml

@@ -0,0 +1,43 @@
+name: Docker
+
+on:
+  push:
+    branches: ['release-*']
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@master
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@master
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@master
+        with:
+          image: AnswerConsulting/AnswerKing-Python
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -102,13 +102,14 @@ celerybeat-schedule.*
 *.sage.py
 
 # Environments
-.env
+.env*
 .venv
 env/
 venv/
 ENV/
 env.bak/
 venv.bak/
+variables_env.tf
 
 # mkdocs documentation
 /site
@@ -143,3 +144,11 @@ GitHub.sublime-settings
 
 .idea/*
 *.sqlite3
+
+# Terraform
+.terraform/
+.terraform.lock.hcl
+terraform.tfstate
+terraform.tfstate.*
+terraform.tfstate.backup
+.terraform.tfstate.lock.info

Dockerfile

@@ -0,0 +1,14 @@
+# syntax=docker/dockerfile:1
+
+FROM python:3.10.8-buster
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+
+COPY . /AnswerKing-Python
+WORKDIR /AnswerKing-Python
+
+RUN pip install poetry
+RUN poetry install --only main
+RUN pip install make
+
+CMD [ "/usr/bin/make", "dockerRunserver"]

Makefile

@@ -9,16 +9,21 @@ clean:
 
 lint:
 	poetry run black . --line-length=79
-	poetry run pycodestyle --ignore=E501 .
+	poetry run pycodestyle . --max-line-length=100 --exclude=**/snapshots/** 
 	poetry run pyright
 
 test: clean
-	poetry run coverage run --omit=*/migrations/*,*answerking/* manage.py test --noinput
+	poetry run coverage run --omit=*/migrations/*,*answerking/*,*/tests/*,*manage.py manage.py test --noinput
 	poetry run coverage report
 	poetry run coverage html
 
 migrate:
 	poetry run python manage.py makemigrations
 	poetry run python manage.py migrate
 
+dockerRunserver:
+	poetry run python manage.py waitForDB
+	poetry run python manage.py migrate
+	poetry run gunicorn -b 0.0.0.0\:8000 answerking.wsgi\:application
+
 prepare: lint test