Merge pull request #31 from jtdub/whois

Whois

Author: jtdub

development/Dockerfile

@@ -14,7 +14,7 @@ COPY poetry.lock .
 
 # hadolint ignore=DL3008
 RUN apt-get update && \
-    apt-get install -y --no-install-recommends nmap iputils-ping traceroute curl mariadb-client libmariadb-dev gcc && \
+    apt-get install -y --no-install-recommends nmap iputils-ping traceroute curl mariadb-client libmariadb-dev gcc whois && \
     apt-get autoremove -y && \
     apt-get clean all && \
     rm -rf /var/lib/apt/lists/*

netopsio/core/admin.py

@@ -1,8 +1,7 @@
 """Register core models in admin panel."""
 
-from django.contrib import admin
-
 from core.models import RequestLog
+from django.contrib import admin
 
 
 class RequestLogAdmin(admin.ModelAdmin):

netopsio/core/api/serializers.py

@@ -1,9 +1,8 @@
 """Core App and Worker Serializers."""
+from core import models
 from django_celery_results.models import TaskResult
 from rest_framework import serializers
 
-from core import models
-
 
 class TaskResultSerializer(serializers.HyperlinkedModelSerializer):
     """TaskResult Serializer."""

netopsio/core/api/urls.py

@@ -1,12 +1,12 @@
 """Netops.io core api urls."""
 
-from rest_framework.routers import DefaultRouter
-
 from core.api import views
+from rest_framework.routers import DefaultRouter
 
 router = DefaultRouter()
 router.register(r"tasks", views.TaskResultViewSet)
 router.register(r"request-logs", views.RequestLogViewSet, basename="requestlog")
 router.register(r"ping", views.PingViewSet, basename="ping")
 router.register(r"traceroute", views.TraceRouteViewSet, basename="traceroute")
 router.register(r"nmap", views.NmapViewSet, basename="nmap")
+router.register(r"whois", views.WhoisViewSet, basename="whois")

netopsio/core/api/views.py

@@ -1,13 +1,13 @@
 """Netops.io core api views."""
 
+from core import models, tasks
+from core.api import serializers
 from django_celery_results.models import TaskResult
 from drf_yasg import openapi
 from drf_yasg.utils import swagger_auto_schema
 from rest_framework import viewsets
 from rest_framework.response import Response
 
-from core import models, tasks
-from core.api import serializers
 from netopsio.utilities import get_ip_address
 
 
@@ -90,3 +90,24 @@ def create(self, request, host=None):
         data = models.TaskModel(task_id=task.task_id)
         serializer = serializers.TaskSerializer(data, context={"request": request})
         return Response(serializer.data)
+
+
+class WhoisViewSet(viewsets.ViewSet):
+    """Whois Viewset."""
+
+    @swagger_auto_schema(
+        request_body=openapi.Schema(
+            type=openapi.TYPE_OBJECT,
+            properties={
+                "host": openapi.Schema(
+                    type=openapi.TYPE_STRING, description="Whois a domain or host."
+                ),
+            },
+        )
+    )  # pylint: disable=no-self-use
+    def create(self, request, host):
+        """whois a host."""
+        task = tasks.whois.delay(host=host)
+        data = models.TaskModel(task_id=task.task_id)
+        serializer = serializers.TaskSerializer(data, context={"request": request})
+        return Response(serializer.data)

netopsio/core/forms.py

@@ -0,0 +1,9 @@
+"""Netops.io core app forms."""
+
+from django import forms
+
+
+class WhoisForm(forms.Form):
+    """Whois form."""
+
+    host = forms.CharField(label="domain or ip address", max_length=256)

netopsio/core/tasks.py

@@ -2,7 +2,6 @@
 import subprocess
 
 from celery import shared_task
-
 from core.models import RequestLog
 
 
@@ -33,3 +32,12 @@ def nmap(host: str) -> str:
     data = RequestLog(ip=host, result=task.stdout.decode("utf-8"), app="nmap")
     data.save()
     return task.stdout.decode("utf-8")
+
+
+@shared_task
+def whois(host: str) -> str:
+    """Whois host worker."""
+    task = subprocess.run(["whois", host], capture_output=True, check=True)
+    data = RequestLog(ip=host, result=task.stdout.decode("utf-8"), app="whois")
+    data.save()
+    return task.stdout.decode("utf-8")

netopsio/core/templates/core/task.html

@@ -9,7 +9,7 @@
         <tbody>
             <tr>
                 <td>{{ status }}</td>
-                <td><a href="/tasks/{{ id }}/">{{ host }}</a></td>
+                <td><a href="{% url 'tasks' %}{{ id }}/">{{ host }}</a></td>
             </tr>
         </tbody>
     </table>

netopsio/core/templates/core/tasks.html

@@ -11,7 +11,7 @@
         <tbody>
         {% for task in results %}
             <tr>
-                <th scope="row"><a href="/tasks/{{ task.task_id }}">{{ task.task_id }}</a></th>
+                <th scope="row"><a href="{% url 'tasks' %}{{ task.task_id }}">{{ task.task_id }}</a></th>
                 <td>{{ task.task_name }}</td>
                 <td>{{ task.status }}</td>
                 <td>{{ task.task_kwargs }}</td>

netopsio/core/templates/core/whois.html

@@ -0,0 +1,9 @@
+{% extends "base.html" %}
+{% block content %}
+{% load crispy_forms_tags %}
+<form action="{% url 'whois' %}" method="post">
+    {% csrf_token %}
+    {{ form|crispy }}
+    <input type="submit" value="Submit" class="btn btn-primary">
+</form>
+{% endblock %}

netopsio/core/tests/test_api.py

@@ -1,9 +1,8 @@
 """Core api tests."""
+from core.api import views
 from django.test import TestCase
 from rest_framework.test import APIRequestFactory
 
-from core.api import views
-
 
 class CoreApiTestCase(TestCase):
     def setUp(self):
@@ -41,3 +40,12 @@ def test_nmap_api(self):
         )
         response = self.nmap.create(request)
         self.assertEqual(response.status_code, 200)
+
+    def test_whois_api(self):
+        request = self.factory.post(
+            "/api/v1/whois/",
+            self.host,
+            content_type=self.content_type,
+        )
+        response = self.nmap.create(request)
+        self.assertEqual(response.status_code, 200)

netopsio/core/tests/test_models.py

@@ -1,7 +1,6 @@
 "Core app tests."
-from django.test import TestCase
-
 from core.models import RequestLog
+from django.test import TestCase
 
 
 class RequestLogTestCase(TestCase):

netopsio/core/tests/test_tasks.py

@@ -1,9 +1,8 @@
 """Core tasks tests."""
 
 
-from django.test import TestCase
-
 from core import tasks
+from django.test import TestCase
 
 
 class TasksTestCase(TestCase):
@@ -21,3 +20,7 @@ def test_traceroute_task(self):
     def test_nmap_task(self):
         nmap = tasks.nmap.delay(host=self.host)
         self.assertIn(nmap.status, ("PENDING", "STARTED", "SUCCESS"))
+
+    def test_whois_task(self):
+        whois = tasks.whois.delay(host=self.host)
+        self.assertIn(whois.status, ("PENDING", "STARTED", "SUCCESS"))

netopsio/core/tests/test_views.py

@@ -10,3 +10,38 @@ def test_index_view(self):
         response = self.client.get("/")
         self.assertTemplateUsed(response, "core/base.html")
         self.assertEqual(response.status_code, 200)
+
+    def test_tasks_view(self):
+        """Test the tasks view."""
+        response = self.client.get("/tasks/")
+        self.assertTemplateUsed(response, "core/tasks.html")
+        self.assertEqual(response.status_code, 200)
+
+    def test_task_details_view(self):
+        """Test the task details view."""
+        response = self.client.get("/tasks/21f58fbc-e8e5-4f72-a783-47300197e7da/")
+        self.assertEqual(response.status_code, 404)
+
+    def test_ping_view(self):
+        """Test the ping view."""
+        response = self.client.get("/ping/")
+        self.assertTemplateUsed(response, "core/task.html")
+        self.assertEqual(response.status_code, 200)
+
+    def test_traceroute_view(self):
+        """Test the traceroute view."""
+        response = self.client.get("/traceroute/")
+        self.assertTemplateUsed(response, "core/task.html")
+        self.assertEqual(response.status_code, 200)
+
+    def test_nmap_view(self):
+        """Test the nmap view."""
+        response = self.client.get("/nmap/")
+        self.assertTemplateUsed(response, "core/task.html")
+        self.assertEqual(response.status_code, 200)
+
+    def test_whois_view(self):
+        """Test the ping view."""
+        response = self.client.get("/whois/")
+        self.assertTemplateUsed(response, "core/whois.html")
+        self.assertEqual(response.status_code, 200)

netopsio/core/urls.py

@@ -1,7 +1,6 @@
 "Core app urls."
-from django.urls import path
-
 from core import views
+from django.urls import path
 
 urlpatterns = [
     path("", views.index, name="core-index"),
@@ -10,4 +9,5 @@
     path("ping/", views.ping, name="ping"),
     path("traceroute/", views.traceroute, name="traceroute"),
     path("nmap/", views.nmap, name="nmap"),
+    path("whois/", views.whois, name="whois"),
 ]

netopsio/core/views.py

@@ -1,10 +1,10 @@
 "Core app views."
+from core import forms, tasks
 from django.http import HttpResponse
 from django.shortcuts import get_object_or_404
 from django.template import loader
 from django_celery_results.models import TaskResult
 
-from core import tasks
 from netopsio.utilities import get_ip_address
 
 
@@ -57,3 +57,25 @@ def nmap(request):
     template = loader.get_template("core/task.html")
     context = {"host": host, "status": task.status, "id": task, "title": "Nmap"}
     return HttpResponse(template.render(context, request))
+
+
+def whois(request):
+    """Whois view."""
+    if request.method == "POST":
+        form = forms.WhoisForm(request.POST)
+
+        if form.is_valid():
+            host = form.cleaned_data["host"]
+            task = tasks.whois.delay(host)
+            template = loader.get_template("core/task.html")
+            context = {
+                "host": host,
+                "status": task.status,
+                "id": task,
+                "title": "Whois",
+            }
+            return HttpResponse(template.render(context, request))
+
+    context = {"form": forms.WhoisForm(), "title": "Whois"}
+    template = loader.get_template("core/whois.html")
+    return HttpResponse(template.render(context, request))

netopsio/netopsio/settings.py

@@ -41,6 +41,8 @@
     "rest_framework",
     "drf_yasg",
     "django_celery_results",
+    "crispy_forms",
+    "crispy_bootstrap5",
     "core",
 ]
 
@@ -148,3 +150,6 @@
     "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
     "PAGE_SIZE": 10,
 }
+
+CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"
+CRISPY_TEMPLATE_PACK = "bootstrap5"

netopsio/netopsio/urls.py

@@ -13,14 +13,13 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+from core.api.urls import router
 from django.contrib import admin
 from django.urls import include, path, re_path
 from drf_yasg import openapi
 from drf_yasg.views import get_schema_view
 from rest_framework import permissions
 
-from core.api.urls import router
-
 schema_view = get_schema_view(  # pylint: disable=invalid-name
     openapi.Info(
         title="NetOps.io API",

netopsio/templates/base.html

@@ -13,17 +13,30 @@
     <script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha256-/xUj+3OJU5yExlq6GSYGSHk7tPXikynS7ogEvDej/m4=" crossorigin="anonymous"></script>
     <nav class="navbar navbar-expand-lg navbar-light bg-light">
       <div class="container-fluid">
-        <a class="navbar-brand" href="#">NetOps.io</a>
+        <a class="navbar-brand" href="{% url 'core-index' %}">NetOps.io</a>
         <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNavAltMarkup" aria-controls="navbarNavAltMarkup" aria-expanded="false" aria-label="Toggle navigation">
           <span class="navbar-toggler-icon"></span>
         </button>
+
+    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNavDarkDropdown"
+      aria-controls="navbarNavDarkDropdown" aria-expanded="false" aria-label="Toggle navigation">
+      <span class="navbar-toggler-icon"></span>
+    </button>
+
         <div class="collapse navbar-collapse" id="navbarNavAltMarkup">
           <div class="navbar-nav">
-            <a class="nav-link" href="/">Home</a>
-            <a class="nav-link" href="/tasks/">Task Results</a>
-            <a class="nav-link" href="/ping/">Ping</a>
-            <a class="nav-link" href="/traceroute/">Traceroute</a>
-            <a class="nav-link" href="/nmap/">Nmap</a>
+            <a class="nav-link" href="{% url 'tasks' %}">Task Results</a>
+            <li class="nav-item dropdown">
+              <a class="nav-link dropdown-toggle" href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                Applications
+              </a>
+              <ul class="dropdown-menu dropdown-menu">
+                <li><a class="nav-link" href="{% url 'ping' %}">Ping</a></li>
+                <li><a class="nav-link" href="{% url 'traceroute' %}">Traceroute</a></li>
+                <li><a class="nav-link" href="{% url 'nmap' %}">Nmap</a></li>
+                <li><a class="nav-link" href="{% url 'whois' %}">Whois</a></li>
+              </ul>
+            </li>
           </div>
         </div>
       </div>