Merge pull request #1 from BureauTech/dev

bibiacoutinho · web-flow · commit 6e0a91cb891a · 2022-04-16T23:19:05.000-03:00
Sprint 1
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,12 @@
+/__pycache__
+/.pytest_cache
+/.github
+/doc
+/venv
+
+.env
+.gitignore
+docker-compose.yml
+dockerfile.*
+LICENSE
+README.md
diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml
@@ -0,0 +1,18 @@
+name: Docker Image CI
+
+on:
+  push:
+    branches: [ dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build the Docker image
+      run: docker compose up -d
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -0,0 +1,35 @@
+name: Python CI
+
+on:
+  push:
+    branches: [ dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.7.11
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7.11
+
+      - name: Set up env
+        run: bash setup-env.sh docker
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Lint with flake8
+        run: |
+          pip install flake8
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+      - name: Test with pytest
+        run: |
+          pip install pytest
+          pytest ./src/tests/*
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+__pycache__
+.pytest_cache
+.env
+venv
+
+!.keep
diff --git a/README.md b/README.md
@@ -1 +1,50 @@
-# BTAlert-IA
+[![License](http://img.shields.io/github/license/BureauTech/BTAlert-AI)](https://github.com/BureauTech/BTAlert-AI/blob/main/LICENSE)
+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/BureauTech/BTAlert-AI/)
+[![Python CI](https://github.com/BureauTech/BTAlert-AI/actions/workflows/python.yml/badge.svg)](https://github.com/BureauTech/BTAlert-AI/actions/workflows/python.yml)
+[![Docker Image CI](https://github.com/BureauTech/BTAlert-AI/actions/workflows/docker-image.yml/badge.svg)](https://github.com/BureauTech/BTAlert-AI/actions/workflows/docker-image.yml)
+
+# BTAlert-AI
+
+BTAlert-AI is an application based on Machine Learning to monitor and predict application outages.
+
+## How to install
+
+### Docker Image
+
+To make it run on your machine without installing everything locally, you can simply run it via docker image, by following the commands below.
+
+```docker compose up```
+
+NOTE: It's important to have [docker installed](https://docs.docker.com/engine/install/) on your machine.
+
+### Locally
+
+In case you want to run it in your machine without using docker, you must run the following commands.
+
+For development environment:
+
+```bash setup-env.sh```
+
+```pip install -r requirements.txt```
+
+```python src/app.py```
+
+### Prerequisites:
+
+You must have installed [Python 3.7.11](https://www.python.org/downloads/release/python-3711/) previously.
+
+# Authors
+
+<table align="center">
+  <tr>
+    <td align="center"><a href="https://github.com/anaclaragraciano"><img src="https://avatars.githubusercontent.com/u/64653864?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ana Clara<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BTAlert-IA/commits?author=anaclaragraciano" title="PO">:sparkles::iphone::open_book:</a></td>
+    <td align="center"><a href="https://github.com/bibiacoutinho"><img src="https://avatars.githubusercontent.com/u/56437723?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Beatriz Coutinho<br>Master</b></sub></a><br /><a href="https://github.com/BureauTech/BTAlert-IA/commits?author=bibiacoutinho" title="Master">:headphones::nail_care::computer_mouse:</a></td>
+    <td align="center"><a href="https://github.com/caiquesjc"><img src="https://avatars.githubusercontent.com/u/54915913?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Caique Nascimento<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BTAlert-IA/commits?author=caiquesjc" title="Dev Team">:keyboard::desktop_computer::computer_mouse:</a></td>    
+    <td align="center"><a href="https://github.com/charles-ramos"><img src="https://avatars.githubusercontent.com/u/25464287?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Charles Ramos<br>PO</b></sub></a><br /><a href="https://github.com/BureauTech/BTAlert-IA/commits?author=charles-ramos" title="Dev Team">:fist_raised::open_book::hamburger:</a></td> 
+</table>
+<table align="center">
+    <td align="center"><a href="https://github.com/danielsantosoliveira"><img src="https://avatars.githubusercontent.com/u/55162125?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Daniel Oliveira<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BTAlert-IA/commits?author=danielsantosoliveira" title="Dev Team">:computer::guitar::soccer:</a></td>
+    <td align="center"><a href="https://github.com/Denis-Lima"><img src="https://avatars.githubusercontent.com/u/55518511?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Denis Lima<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BTAlert-IA/commits?author=Denis-Lima" title="Dev Team">:computer::v::pizza:</a></td>
+    <td align="center"><a href="https://github.com/WeDias"><img src="https://avatars.githubusercontent.com/u/56437612?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wesley Dias<br>Dev</b></sub></a><br /><a href="https://github.com/BureauTech/BTAlert-IA/commits?author=WeDias" title="Dev Team">:rocket::milky_way::new_moon:</a></td>
+  </tr>
+</table>
diff --git a/doc/.keep b/doc/.keep
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,17 @@
+version: '3.9'
+
+services:
+
+  btalert-ai:
+    container_name: btalert-ai
+    build:
+      context: .
+      dockerfile: dockerfile.python
+    ports:
+      - 5050:5050
+    networks:
+      - backend_network
+
+networks:
+  backend_network:
+    name: backend_network
diff --git a/dockerfile.python b/dockerfile.python
@@ -0,0 +1,9 @@
+FROM python:3.7.11
+WORKDIR /usr/src/btalert-ai
+
+COPY . .
+RUN bash setup-env.sh docker
+RUN pip install -r requirements.txt
+
+WORKDIR /usr/src/btalert-ai/src
+CMD ["gunicorn", "--bind", "0.0.0.0:5050", "app:app"]
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,41 @@
+attrs==21.4.0
+backports.zoneinfo==0.2.1
+certifi==2021.10.8
+charset-normalizer==2.0.12
+click==8.1.2
+dateparser==1.1.1
+Flask==2.1.1
+gunicorn==20.1.0
+idna==3.3
+importlib-metadata==4.11.3
+iniconfig==1.1.1
+itsdangerous==2.1.2
+Jinja2==3.1.1
+joblib==1.1.0
+MarkupSafe==2.1.1
+numpy==1.21.5
+packaging==21.3
+pandas==1.3.5
+pluggy==1.0.0
+prometheus-api-client==0.5.0
+prometheus-client==0.14.1
+py==1.11.0
+pyparsing==3.0.8
+pytest==7.1.1
+python-dateutil==2.8.2
+python-dotenv==0.20.0
+pytz==2022.1
+pytz-deprecation-shim==0.1.0.post0
+regex==2022.3.2
+requests==2.27.1
+scikit-learn==1.0.2
+scipy==1.7.3
+six==1.16.0
+threadpoolctl==3.1.0
+tomli==2.0.1
+typing-extensions==4.1.1
+tzdata==2022.1
+tzlocal==4.2
+urllib3==1.26.9
+Werkzeug==2.1.1
+zipp==3.8.0
diff --git a/runtime.txt b/runtime.txt
@@ -0,0 +1 @@
+python-3.7.11
diff --git a/setup-env.sh b/setup-env.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+
+ENV_TYPE=${1:-"dev"}
+ENV_PATH="./src/resources/"
+
+if [ $# -eq 0 ]
+then
+    echo "using default env (dev)"
+fi
+
+if test -f "$ENV_PATH/$ENV_TYPE.env"
+then
+    echo 'setting environment variables'
+    echo -n > .env && cat $ENV_PATH/$ENV_TYPE.env >> .env
+    echo "env" $ENV_TYPE": successfully configured!"
+else
+    echo "env" $ENV_TYPE": error configuring environment! check if you chose a valid env."
+    echo "available envs: dev, docker."
+fi
diff --git a/src/app.py b/src/app.py
@@ -0,0 +1,27 @@
+import os
+
+from flask import Flask
+from dotenv import load_dotenv
+from werkzeug.middleware.dispatcher import DispatcherMiddleware
+from prometheus_client import make_wsgi_app, Gauge
+from prometheus_api_client import PrometheusConnect
+
+
+load_dotenv()
+
+
+app = Flask(__name__)
+prom = PrometheusConnect(url=os.getenv('PROMETHEUS_URL'), disable_ssl=True)
+
+btalert_ai_prediction = Gauge('btalert_ai_prediction', 'estimated time in hours for the system to be down')
+btalert_ai_prediction.set(1)
+
+btalert_ai_total_metrics = Gauge('btalert_ai_total_metrics', 'total of metrics available on prometheus')
+btalert_ai_total_metrics.set(len(prom.all_metrics()))
+
+app.wsgi_app = DispatcherMiddleware(app.wsgi_app, {
+    '/metrics': make_wsgi_app()
+})
+
+if __name__ == '__main__':
+    app.run('localhost', 5050)
diff --git a/src/resources/dev.env b/src/resources/dev.env
@@ -0,0 +1 @@
+PROMETHEUS_URL=http://localhost:9090
diff --git a/src/resources/docker.env b/src/resources/docker.env
@@ -0,0 +1 @@
+PROMETHEUS_URL=http://prometheus:9090
diff --git a/src/scripts/.keep b/src/scripts/.keep
diff --git a/src/tests/test_example.py b/src/tests/test_example.py
@@ -0,0 +1,4 @@
+class TestClass:
+
+    def test_one(self):
+        assert 1 == 1

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +__pycache__
 +.pytest_cache
 +.env
 +venv
++
 +!.keep