feat: ✨ speedtest card added

codeperfectplus · codeperfectplus · commit 7f09d11b17b9 · 2024-08-24T20:08:15.000+05:30
diff --git a/README.md b/README.md
@@ -32,3 +32,14 @@ http://localhost:5000
 ## Why not the docker image?
 
 I have not created the docker image for this project because it requires the access to the host machine to get the server stats. So, it is not possible to get the server stats from the docker container.
+
+
+## Acknowledgments
+
+- This project uses `speedtest-cli` for performing speed tests. `speedtest-cli` is licensed under the Apache License 2.0. For more details, please refer to its [GitHub repository](https://github.com/sivel/speedtest-cli).
+
+- This project uses `psutil` for getting the system stats. `psutil` is licensed under the BSD 3-Clause "New" or "Revised" License. For more details, please refer to its [GitHub repository](https://github.com/giampaolo/psutil)
+
+- This project uses `flask` for creating the web app. `flask` is licensed under the BSD 3-Clause "New" or "Revised" License. For more details, please refer to its [GitHub repository](https://github.com/pallets/flask)
+
+- This project uses `chart.js` for creating the charts. `chart.js` is licensed under the MIT License. For more details, please refer to its [GitHub repository](https://github.com/chartjs/Chart.js)
diff --git a/app.py b/app.py
@@ -1,21 +1,43 @@
 from flask import Flask, render_template
+from flask_sqlalchemy import SQLAlchemy
 import os
 import psutil
 import datetime
+import subprocess
 
 app = Flask(__name__)
 
+# Configure the SQLite database
+app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///speedtest_results.db'
+app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+
+# Initialize the database
+db = SQLAlchemy(app)
+
+# Define the model for storing speed test results
+class SpeedTestResult(db.Model):
+    id = db.Column(db.Integer, primary_key=True)
+    download_speed = db.Column(db.String(50))
+    upload_speed = db.Column(db.String(50))
+    ping = db.Column(db.String(50))
+    timestamp = db.Column(db.DateTime, default=datetime.datetime.utcnow)
+
+    def __repr__(self):
+        return f'<SpeedTestResult {self.download_speed}, {self.upload_speed}, {self.ping}>'
+
 def get_established_connections():
-    connection = psutil.net_connections()
-    ipv4_dict = {}
-    ipv6_dict = {}
+    connections = psutil.net_connections()
+    ipv4_dict = set()
+    ipv6_dict = set()
 
-    for conn in connection:
+    for conn in connections:
         if conn.status == 'ESTABLISHED':
             if '.' in conn.laddr.ip:
-                ipv4_dict = conn.laddr.ip
+                ipv4_dict.add(conn.laddr.ip)
             elif ':' in conn.laddr.ip:
-                ipv6_dict = conn.laddr.ip
+                ipv6_dict.add(conn.laddr.ip)
+
+    ipv4_dict = [ip for ip in ipv4_dict if ip.startswith('192.168')][0]
 
     return ipv4_dict, ipv6_dict
 
@@ -31,32 +53,85 @@ def change_up_time_format(uptime):
 def get_system_info():
     info = {
         'username': os.getlogin(),
-        'cpu_percent': psutil.cpu_percent(interval=1),
-        'memory_percent': psutil.virtual_memory().percent,
-        'disk_usage': psutil.disk_usage('/').percent,
+        'cpu_percent': round(psutil.cpu_percent(interval=1), 2),
+        'memory_percent': round(psutil.virtual_memory().percent, 2),
+        'disk_usage': round(psutil.disk_usage('/').percent, 2),
         'battery_percent': round(psutil.sensors_battery().percent) if psutil.sensors_battery() else "N/A",
         'cpu_core': psutil.cpu_count(),
         'boot_time': datetime.datetime.fromtimestamp(psutil.boot_time()).strftime("%Y-%m-%d %H:%M:%S"),
         'network_sent': round(psutil.net_io_counters().bytes_sent / (1024 ** 2), 2),  # In MB
         'network_received': round(psutil.net_io_counters().bytes_recv / (1024 ** 2), 2),  # In MB
         'process_count': len(psutil.pids()),
         'swap_memory': psutil.swap_memory().percent,
-        'uptime': change_up_time_format(datetime.datetime.now() - datetime.datetime.fromtimestamp(psutil.boot_time()))
+        'uptime': change_up_time_format(datetime.datetime.now() - datetime.datetime.fromtimestamp(psutil.boot_time())),
+        'ipv4_connections': get_established_connections()[0],
+        'ipv6_connections': get_established_connections()[1]
     }
-
-    ipv4_conn, ipv6_conn = get_established_connections()
-    info['ipv4_connections'] = ipv4_conn
-    info['ipv6_connections'] = ipv6_conn
     return info
 
+def run_speedtest():
+    try:
+        # Run the speedtest and capture the output
+        result = subprocess.run(['speedtest-cli'], capture_output=True, text=True, check=True)
+        
+        # Extract relevant information from the output
+        output_lines = result.stdout.splitlines()
+        download_speed = None
+        upload_speed = None
+        ping = None
+        
+        for line in output_lines:
+            if "Download:" in line:
+                download_speed = line.split("Download: ")[1]
+            elif "Upload:" in line:
+                upload_speed = line.split("Upload: ")[1]
+            elif "Ping:" in line:
+                ping = line.split("Ping: ")[1]
+        
+        return {"download_speed": download_speed, "upload_speed": upload_speed, "ping": ping}
+    
+    except subprocess.CalledProcessError as e:
+        print(f"Speedtest failed with error: {e.stderr}")
+        return None
+    
+    except Exception as e:
+        print(f"Error occurred while running speed test: {e}")
+        return None
+
+@app.route('/speedtest')
+def speedtest():
+    # Check if the database has three or more entries in the last hour
+    one_hour_ago = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
+    recent_results = SpeedTestResult.query.filter(SpeedTestResult.timestamp > one_hour_ago).all()
+
+    if len(recent_results) < 3:
+        # Run a new speed test and store the result
+        speedtest_result = run_speedtest()
+        if speedtest_result:
+            new_result = SpeedTestResult(
+                download_speed=speedtest_result['download_speed'],
+                upload_speed=speedtest_result['upload_speed'],
+                ping=speedtest_result['ping']
+            )
+            db.session.add(new_result)
+            db.session.commit()
+            return render_template('speedtest_result.html', speedtest_result=speedtest_result, source="Actual Test")
+    else:
+        # Retrieve the latest result from the database
+        latest_result = recent_results[-1]
+        next_test_time = one_hour_ago + datetime.timedelta(hours=1)
+        return render_template('speedtest_result.html', 
+                               speedtest_result=latest_result, 
+                               source="Database", 
+                               next_test_time=next_test_time)
+
 @app.route('/')
 def dashboard():
     system_info = get_system_info()
     return render_template('dashboard.html', system_info=system_info)
 
 @app.route('/cpu_usage')
 def cpu_usage():
-    # Detailed CPU usage stats
     cpu_usage = psutil.cpu_percent(interval=1, percpu=True)
     return render_template('cpu_usage.html', cpu_usage=cpu_usage)
 
@@ -90,10 +165,11 @@ def network_stats():
 
 @app.route('/system_health')
 def system_health():
-    # Reuse system_info function for summary
     system_info = get_system_info()
     return render_template('system_health.html', system_info=system_info)
 
-
 if __name__ == '__main__':
+    # Create the database tables if they don't exist
+    with app.app_context():
+        db.create_all()
     app.run(host='0.0.0.0', port=5000, debug=True)
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,5 @@
 Flask==2.3.3
 psutil==5.9.5
 gunicorn
+speetest-cli
+flask-sqlalchemy
diff --git a/templates/dashboard.html b/templates/dashboard.html
@@ -18,14 +18,14 @@ <h5 class="card-title">Username <i class="fas fa-user"></i></h5>
         <div class="col-md-6 col-lg-4 mb-4">
             <div class="card shadow-sm border-0 rounded-3">
                 <div class="card-body">
-                    <h5 class="card-title">IPV4 <i class="fas fa-network-wired"></i></h5>
+                    <h5 class="card-title">IPV4 Connections <i class="fas fa-network-wired"></i></h5>
                     <p class="card-text fs-4">{{ system_info['ipv4_connections'] }}</p>
                 </div>
             </div>
         </div>
 
         <div class="col-md-6 col-lg-4 mb-4">
-            <div class="card shadow-sm border-0 rounded-3 battery-card" data-battery="{{ system_info['battery_percent'] }}">
+            <div class="card shadow-sm border-0 rounded-3">
                 <div class="card-body">
                     <h5 class="card-title">Battery Percentage <i class="fas fa-battery-three-quarters"></i></h5>
                     <p class="card-text fs-4">{{ system_info['battery_percent'] }}%</p>
@@ -36,7 +36,7 @@ <h5 class="card-title">Battery Percentage <i class="fas fa-battery-three-quarter
         <div class="col-md-6 col-lg-4 mb-4">
             <div class="card shadow-sm border-0 rounded-3">
                 <div class="card-body">
-                    <h5 class="card-title">CPU Core <i class="fas fa-microchip"></i></h5>
+                    <h5 class="card-title">CPU Cores <i class="fas fa-microchip"></i></h5>
                     <p class="card-text fs-4">{{ system_info['cpu_core'] }}</p>
                 </div>
             </div>
@@ -103,6 +103,11 @@ <h5 class="card-title">Network Statistics <i class="fas fa-network-wired"></i></
                 </div>
             </div>
         </div>
+
+        <!-- Speed Test Button -->
+        <div class="col-md-12 mb-4 text-center">
+            <a href="{{ url_for('speedtest') }}" class="btn btn-primary btn-lg">Run Speed Test</a>
+        </div>
     </div>
 </div>
 {% endblock %}
diff --git a/templates/speedtest_result.html b/templates/speedtest_result.html
@@ -0,0 +1,50 @@
+{% extends 'base.html' %}
+
+{% block title %}Speed Test Result{% endblock %}
+
+{% block content %}
+<div class="container mt-5">
+    <div class="row justify-content-center">
+        <div class="col-md-8">
+            <div class="card shadow-sm border-0 rounded-3">
+                <div class="card-body">
+                    <h1 class="card-title text-center mb-4">Speed Test Result</h1>
+                    {% if speedtest_result %}
+                        <ul class="list-group list-group-flush">
+                            <li class="list-group-item d-flex justify-content-between align-items-center">
+                                <strong>Download Speed:</strong> 
+                                <span>{{ speedtest_result.download_speed }}</span>
+                            </li>
+                            <li class="list-group-item d-flex justify-content-between align-items-center">
+                                <strong>Upload Speed:</strong> 
+                                <span>{{ speedtest_result.upload_speed }}</span>
+                            </li>
+                            <li class="list-group-item d-flex justify-content-between align-items-center">
+                                <strong>Ping:</strong> 
+                                <span>{{ speedtest_result.ping }}</span>
+                            </li>
+                            <li class="list-group-item d-flex justify-content-between align-items-center">
+                                <strong>Source:</strong> 
+                                <span>{{ source }}</span>
+                            </li>
+                            {% if source == "Database" %}
+                                <li class="list-group-item d-flex justify-content-between align-items-center">
+                                    <strong>Next Test Time:</strong> 
+                                    <span>{{ next_test_time }}</span>
+                                </li>
+                            {% endif %}
+                        </ul>
+                    {% else %}
+                        <div class="alert alert-warning text-center" role="alert">
+                            No speed test results available.
+                        </div>
+                    {% endif %}
+                    <div class="text-center mt-4">
+                        <a href="{{ url_for('dashboard') }}" class="btn btn-primary">Back to Dashboard</a>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+{% endblock %}
