Merge pull request #11 from jtdub/ping

Ping App

Author: jtdub

.github/workflows/linting.yaml

@@ -13,7 +13,7 @@ jobs:
     - uses: actions/checkout@v2
     - uses: hadolint/[email protected]
       with:
-        dockerfile: Dockerfile
+        dockerfile: development/Dockerfile
   black:
     runs-on: ubuntu-latest
     strategy:
@@ -30,7 +30,7 @@ jobs:
       uses: "networktocode/gh-action-setup-poetry-environment@v2"
     - name: "Linting: Black"
       run: |
-        poetry run black --diff netopsio/
+        poetry run invoke black
   pylint:
     runs-on: ubuntu-latest
     strategy:
@@ -47,7 +47,7 @@ jobs:
       uses: "networktocode/gh-action-setup-poetry-environment@v2"
     - name: "Linting: PyLint"
       run: |
-        poetry run pylint netopsio/netopsio/ netopsio/home/
+        poetry run invoke pylint
   flake8:
     runs-on: ubuntu-latest
     strategy:
@@ -64,4 +64,4 @@ jobs:
       uses: "networktocode/gh-action-setup-poetry-environment@v2"
     - name: "Linting: Flake8"
       run: |
-        poetry run flake8 netopsio/ --ignore E501
+        poetry run invoke flake8

.github/workflows/unit-tests.yaml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.10"]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
@@ -23,4 +23,8 @@ jobs:
       uses: "networktocode/gh-action-setup-poetry-environment@v2"
     - name: Execute Unit Tests
       run: |
-        cd netopsio; poetry run ./manage.py test; cd -
+        poetry run invoke build
+        poetry run invoke start
+        sleep 20
+        poetry run invoke migrate
+        poetry run invoke unittest

.pylintrc

@@ -0,0 +1,2 @@
+[MESSAGES CONTROL]
+disable=no-member

Dockerfile renamed to development/Dockerfile

@@ -1,20 +1,20 @@
 FROM python:3.10-slim-bullseye
 
-WORKDIR /opt/netopsio
-
 ENV PATH="${PATH}:/root/.local/bin"
 
 EXPOSE 8000
 
-COPY netopsio /opt/netopsio
+WORKDIR /opt/netopsio
+
+VOLUME /opt/netopsio
 
 COPY pyproject.toml .
 
 COPY poetry.lock .
 
 # hadolint ignore=DL3008
 RUN apt-get update && \
-    apt-get install -y --no-install-recommends nmap iputils-ping traceroute curl && \
+    apt-get install -y --no-install-recommends nmap iputils-ping traceroute curl mariadb-client libmariadb-dev gcc && \
     apt-get autoremove -y && \
     apt-get clean all && \
     rm -rf /var/lib/apt/lists/*
@@ -28,5 +28,3 @@ RUN curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/inst
 RUN poetry config virtualenvs.create false && \
     poetry config installer.parallel false && \
     poetry install
-
-CMD ["./manage.py", "runserver", "0.0.0.0:8000", "--insecure"]

development/creds.env

@@ -0,0 +1,13 @@
+# NETOPSIOS Settings
+NETOPSIO_DB_NAME = "netopsio"
+NETOPSIO_DB_USER = "root"
+NETOPSIO_DB_PASS = "superduper"
+NETOPSIO_DB_HOST = "db"
+NETOPSIO_BROKER_URL = "redis://redis:6379/0"
+
+# Database Settings
+MARIADB_DATABASE = "netopsio"
+MARIADB_ROOT_PASSWORD = "superduper"
+
+# Redis Settings
+REDIS_HOST = "redis"

development/docker-compose.yaml

@@ -0,0 +1,45 @@
+version: "3.9"
+services:
+  db:
+    image: "mariadb:latest"
+    env_file: "creds.env"
+  redis:
+    image: "redis:latest"
+  proxy:
+    image: "haproxy:latest"
+    volumes:
+    - ./haproxy:/usr/local/etc/haproxy
+    ports:
+    - "80:80"
+    links:
+    - "app"
+  worker:
+    build:
+      context: ../
+      dockerfile: ./development/Dockerfile
+    env_file: "creds.env"
+    volumes:
+    - ../netopsio:/opt/netopsio
+    depends_on:
+    - "db"
+    - "redis"
+    links:
+    - "db"
+    - "redis"
+    command: ["celery", "-A", "netopsio", "worker", "-l", "INFO"]
+  app:
+    build:
+      context: ../
+      dockerfile: ./development/Dockerfile
+    env_file: "creds.env"
+    ports:
+    - "8000:8000"
+    volumes:
+    - ../netopsio:/opt/netopsio
+    depends_on:
+    - "db"
+    links:
+    - "db"
+    - "worker"
+    restart: "always"
+    command: ["./scripts/delay-start.sh", "./manage.py", "runserver", "0.0.0.0:8000", "--insecure"]

development/haproxy/haproxy.cfg

@@ -0,0 +1,17 @@
+defaults
+    timeout connect 10s
+    timeout client 30s
+    timeout server 30s
+    log global
+    mode http
+    option httplog
+    maxconn 3000
+
+frontend http_server
+    bind 0.0.0.0:80
+    default_backend app_server
+
+backend app_server
+    balance roundrobin
+    option forwardfor
+    server app1 app:8000

netopsio/home/templates/home/base.html

@@ -1,15 +1,4 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-
-    <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-KyZXEAg3QhqLMpG8r+8fhAXLRk2vvoC2f3B09zVXn8CA5QIVfZOJ3BCsw2P0p/We" crossorigin="anonymous">
-
-    <title>NetOps.io</title>
-  </head>
-  <body>
-    <h1>NetOps.io</h1>
-    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-U1DAWAznBHeqEIlVSCgzq+c9gqGAJn5c/t99JyeKa9xxaYpSvHU5awsuZVVFIhvj" crossorigin="anonymous"></script>
-  </body>
-</html>
+{% extends "base.html" %}
+{% block content %}
+<div class="container">{{ title }}</div>
+{% endblock %}

netopsio/home/templates/home/result_details.html

@@ -0,0 +1,13 @@
+{% extends "base.html" %}
+{% block content %}
+<div class="container">
+    <div class="mb-3">
+        <label for="statusArea" class="form-label"><h3>Job Status</h3></label>
+        <input type="input" class="form-control" id="statusArea" placeholder="{{ job.status }}">
+    </div>
+    <div class="mb-3">
+        <label for="resultTextArea" class="form-label"><h3>{{ title }}</h3></label>
+        <textarea class="form-control" id="resultTextArea" rows="5">{{ job.result }}</textarea>
+    </div>
+</div>
+{% endblock %}

netopsio/home/templates/home/results.html

@@ -0,0 +1,23 @@
+{% extends "base.html" %}
+{% block content %}
+<div class="container">
+    <table class="table">
+        <thead>
+            <th scope="col">ID</th>
+            <th scope="col">Task Name</th>
+            <th scope="col">Task Status</th>
+            <th scope="col">Keyword Arguments</th>
+        </thead>
+        <tbody>
+        {% for task in results %}
+            <tr>
+                <th scope="row"><a href="/results/{{ task.task_id }}">{{ task.task_id }}</a></th>
+                <td>{{ task.task_name }}</td>
+                <td>{{ task.status }}</td>
+                <td>{{ task.task_kwargs }}</td>
+            </tr>
+        {% endfor %}
+        </tbody>
+    </table>
+</div>
+{% endblock %}

netopsio/home/urls.py

@@ -4,5 +4,7 @@
 
 app_name = ""  # pylint: disable=invalid-name
 urlpatterns = [
-    path("", views.index, name="index"),
+    path("", views.index, name="home_index"),
+    path("results/", views.results, name="home_results"),
+    path("results/<str:task_id>/", views.result_details, name="results_details"),
 ]

netopsio/home/views.py

@@ -1,10 +1,28 @@
 "Home app views."
 from django.http import HttpResponse
 from django.template import loader
+from django.shortcuts import get_object_or_404
+from django_celery_results.models import TaskResult
 
 
 def index(request):
     """Render Home Page."""
     template = loader.get_template("home/base.html")
-    context = {}
+    context = {"title": "Home"}
+    return HttpResponse(template.render(context, request))
+
+
+def results(request):
+    """Render Task Results."""
+    task_results = TaskResult.objects.all()
+    template = loader.get_template("home/results.html")
+    context = {"title": "Task Results", "results": task_results}
+    return HttpResponse(template.render(context, request))
+
+
+def result_details(request, task_id):
+    """Render Task Detail Results."""
+    job = get_object_or_404(TaskResult, task_id=task_id)
+    template = loader.get_template("home/result_details.html")
+    context = {"title": "Task Result Details", "job": job}
     return HttpResponse(template.render(context, request))

netopsio/manage.py

@@ -1,4 +1,6 @@
 #!/usr/bin/env python
+# pylint: skip-file
+
 """Django's command-line utility for administrative tasks."""
 import os
 import sys

netopsio/netopsio/__init__.py

@@ -0,0 +1,4 @@
+"""Netops.io Project Base."""
+from .celery import app as celery_app
+
+__all__ = ("celery_app",)

netopsio/netopsio/celery.py

@@ -0,0 +1,21 @@
+"""Celery Jobs Initialization"""
+
+import os
+
+from celery import Celery
+
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "netopsio.settings")
+
+app = Celery(
+    "netopsio",
+    broker=f"{os.getenv('NETOPSIO_BROKER_URL')}",
+)
+app.config_from_object("django.conf:settings", namespace="CELERY")
+app.autodiscover_tasks()
+
+
+@app.task(bind=True)
+def debug_task(self):
+    """Celery Debug Task"""
+    print(f"Request: {self.request!r}")

netopsio/netopsio/settings.py

@@ -11,6 +11,7 @@
 """
 
 from pathlib import Path
+import os
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
@@ -37,7 +38,9 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "django_celery_results",
     "home",
+    "ping",
 ]
 
 MIDDLEWARE = [
@@ -55,7 +58,7 @@
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
-        "DIRS": [],
+        "DIRS": ["./templates"],
         "APP_DIRS": True,
         "OPTIONS": {
             "context_processors": [
@@ -76,12 +79,17 @@
 
 DATABASES = {
     "default": {
-        "ENGINE": "django.db.backends.sqlite3",
-        "NAME": BASE_DIR / "db.sqlite3",
+        "ENGINE": "django.db.backends.mysql",
+        "NAME": os.getenv("NETOPSIO_DB_NAME"),
+        "USER": os.getenv("NETOPSIO_DB_USER"),
+        "PASSWORD": os.getenv("NETOPSIO_DB_PASS"),
+        "HOST": os.getenv("NETOPSIO_DB_HOST"),
+        "OPTIONS": {
+            "init_command": "SET default_storage_engine=INNODB",
+        },
     }
 }
 
-
 # Password validation
 # https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
 
@@ -124,3 +132,12 @@
 # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+# Celery Options
+CELERY_TIMEZONE = "US/Central"
+
+CELERY_TASK_TRACK_STARTED = True
+
+CELERY_TASK_TIME_LIMIT = 30 * 60
+
+CELERY_RESULT_BACKEND = "django-db"

netopsio/netopsio/urls.py

@@ -17,6 +17,7 @@
 from django.urls import include, path
 
 urlpatterns = [
-    path("", include("home.urls")),
+    path("", include("home.urls"), name="home"),
+    path("ping/", include("ping.urls"), name="ping"),
     path("admin/", admin.site.urls),
 ]

netopsio/ping/__init__.py

@@ -0,0 +1,13 @@
+"""Register Ping Models in Admin Pandel."""
+
+from django.contrib import admin
+from ping.models import PingRequest
+
+
+class PingAdmin(admin.ModelAdmin):
+    """Ping Admin Site Fields."""
+
+    list_display = ("ip", "date")
+
+
+admin.site.register(PingRequest, PingAdmin)

netopsio/ping/admin.py

@@ -0,0 +1,8 @@
+# pylint: skip-file
+
+from django.apps import AppConfig
+
+
+class PingConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "ping"