Merge pull request #40 from 5g-mobility/dev

Merge w/ Main

Author: hugofpaiva

.github/workflows/django.yml

@@ -0,0 +1,35 @@
+name: Run Django tests
+
+on: 
+  push:
+    branches: [ dev, main ]
+  pull_request:
+    branches: [ dev, main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.8'
+      - name: Create MongoDB container
+        run: make db-up
+      - name: Install Django dependencies
+        run: make install
+      - name: Make Migrations
+        run: make migrate
+      - name: Run tests
+        run: make test
+      - name: Install Lint dependencies
+        run: pip install flake8
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude venv
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --exclude venv

.gitignore

@@ -1,5 +1,127 @@
-# Byte-compiled / optimized / DLL files
+.idea/
+
+# Created by https://www.gitignore.io/api/macos,linux,django,python,pycharm
+
+### Django ###
+*.log
+*.pot
+*.pyc
 __pycache__/
+local_settings.py
+db.sqlite3
+media
+
+.mapbox_token
+
+# Flower DB
+flower/flower
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### Python ###
+# Byte-compiled / optimized / DLL files
 *.py[cod]
 *$py.class
 
@@ -8,6 +130,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+env/
 build/
 develop-eggs/
 dist/
@@ -20,12 +143,9 @@ parts/
 sdist/
 var/
 wheels/
-pip-wheel-metadata/
-share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
-MANIFEST
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -40,26 +160,18 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
-.nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
-*.cover
-*.py,cover
+*,cover
 .hypothesis/
-.pytest_cache/
 
 # Translations
 *.mo
-*.pot
 
 # Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -77,38 +189,22 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
-# IPython
-profile_default/
-ipython_config.py
-
 # pyenv
 .python-version
 
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
+# celery beat schedule file
 celerybeat-schedule
-celerybeat.pid
 
 # SageMath parsed files
 *.sage.py
 
-# Environments
+# dotenv
 .env
+
+# virtualenv
 .venv
-env/
 venv/
 ENV/
-env.bak/
-venv.bak/
 
 # Spyder project settings
 .spyderproject
@@ -120,10 +216,4 @@ venv.bak/
 # mkdocs documentation
 /site
 
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
+# End of https://www.gitignore.io/api/macos,linux,django,python,pycharm

Dockerfile

@@ -0,0 +1,26 @@
+FROM python:3.8
+ENV PYTHONUNBUFFERED=1
+WORKDIR /code
+COPY requirements.txt /code/
+RUN python -m pip install --upgrade pip
+RUN pip install --upgrade -r requirements.txt
+RUN apt-get update
+RUN apt-get install --yes nginx
+RUN apt-get install -y cron && touch /var/log/cron.log
+
+# OSM Client
+RUN apt-get update
+RUN apt -y install software-properties-common dirmngr apt-transport-https lsb-release ca-certificates
+RUN sed -i "/osm-download.etsi.org/d" /etc/apt/sources.list
+RUN wget -qO - https://osm-download.etsi.org/repository/osm/debian/ReleaseNINE/OSM%20ETSI%20Release%20Key.gpg | apt-key add -
+RUN add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseNINE stable devops IM osmclient"
+RUN apt-get update
+RUN python -m pip install python-magic pyangbind verboselogs
+RUN apt-get install -y python3-osmclient
+
+RUN cp -r /usr/lib/python3/dist-packages/osmclient /usr/local/lib/python3.8/site-packages
+RUN cp -r /usr/lib/python3/dist-packages/osm_im /usr/local/lib/python3.8/site-packages
+RUN pip install pyyaml==5.4.1
+RUN pip install pycurl==7.43.0.6
+
+COPY . /code/

Makefile

@@ -0,0 +1,69 @@
+VENV := venv
+BIN := $(VENV)/bin
+PYTHON := $(BIN)/python
+SHELL := /bin/bash
+
+# This ensures make has access to environment variables stored in a file called .env. 
+# This allows Make to utilize these variables in its commands, for example, the name of my virtual environment, or to pass in $(DBNAME) to psql.
+#include .env
+
+.PHONY: help
+help: ## Show this help
+	@egrep -h '\s##\s' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: venv
+venv: ## Make a new virtual environment
+	python3 -m venv $(VENV) && source $(BIN)/activate
+
+.PHONY: install
+install: venv ## Make venv and install requirements
+	$(PYTHON) -m pip install --upgrade pip
+	$(BIN)/pip install --upgrade -r requirements.txt
+
+.PHONY: freeze
+freeze: ## Pin current dependencies
+	$(BIN)/pip freeze > requirements.txt
+
+.PHONY: migrate
+migrate: ## Make and run migrations
+	$(PYTHON) manage.py makemigrations
+	$(PYTHON) manage.py migrate
+
+.PHONY: db-up
+db-up: ## Pull and start the Docker MongoDB container in the background
+	cd mongodb && docker-compose up -d
+
+.PHONY: volume-down
+volume-down: ## Remove volume of MongoDB Container
+	docker volume rm mongodb-data
+
+.PHONY: volume-up
+volume-up: ## Create volume of MongoDB Container
+	docker volume create mongodb-data
+
+.PHONY: fixtures
+fixtures: ## Load fixtures
+	$(PYTHON) manage.py loaddata event.json climate.json dailyinflow.json
+
+.PHONY: mqtt-consumer
+mqtt-consumer: ## Run MQTT consumer
+	$(PYTHON) manage.py mqtt_consumer
+
+.PHONY: test
+test: ## Run tests 
+	$(PYTHON) manage.py test --verbosity=0 --failfast
+
+.PHONY: test-docker
+test-docker: ## Run tests on Docker Container
+	docker-compose run --service-ports -e DB_USER=admin -e DB_PASSWORD=admin -e DB_AUTH=admin django python manage.py test --verbosity=0 --failfast
+
+.PHONY: run
+run: ## Run the Django server
+	$(PYTHON) manage.py runserver
+
+.PHONY: prod
+prod: ## Start all services containers
+	docker-compose build
+	docker-compose up -d
+
+