diff options
Diffstat (limited to 'unittest-restful.py')
| -rwxr-xr-x | unittest-restful.py | 286 |
1 files changed, 286 insertions, 0 deletions
diff --git a/unittest-restful.py b/unittest-restful.py new file mode 100755 index 00000000..bc2dc330 --- /dev/null +++ b/unittest-restful.py @@ -0,0 +1,286 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# Glances - An eye on your system +# +# SPDX-FileCopyrightText: 2022 Nicolas Hennion <nicolas@nicolargo.com> +# +# SPDX-License-Identifier: LGPL-3.0-only +# + +"""Glances unitary tests suite for the RESTful API.""" + +import os +import shlex +import subprocess +import time +import numbers +import unittest + +from glances.outputs.glances_restful_api import GlancesRestfulApi +from glances import __version__ +from glances.globals import text_type + +import requests + +SERVER_PORT = 61234 +API_VERSION = GlancesRestfulApi.API_VERSION +URL = "http://localhost:{}/api/{}".format(SERVER_PORT, API_VERSION) +pid = None + +# Unitest class +# ============== +print('RESTful API unitary tests for Glances %s' % __version__) + + +class TestGlances(unittest.TestCase): + """Test Glances class.""" + + def setUp(self): + """The function is called *every time* before test_*.""" + print('\n' + '=' * 78) + + def http_get(self, url, gzip=False): + """Make the request""" + if gzip: + ret = requests.get(url, + stream=True, + headers={'Accept-encoding': 'gzip'}) + else: + ret = requests.get(url, + headers={'Accept-encoding': 'identity'}) + return ret + + def test_000_start_server(self): + """Start the Glances Web Server.""" + global pid + + print('INFO: [TEST_000] Start the Glances Web Server API') + if os.path.isfile('./venv/bin/python'): + cmdline = "./venv/bin/python" + else: + cmdline = "python" + cmdline += " -m glances -B 0.0.0.0 -w -p %s --disable-webui -C ./conf/glances.conf" % SERVER_PORT + print("Run the Glances Web Server on port %s" % SERVER_PORT) + args = shlex.split(cmdline) + pid = subprocess.Popen(args) + print("Please wait 5 seconds...") + time.sleep(5) + + self.assertTrue(pid is not None) + + def test_001_all(self): + """All.""" + method = "all" + print('INFO: [TEST_001] Get all stats') + print("HTTP RESTful request: %s/%s" % (URL, method)) + req = self.http_get("%s/%s" % (URL, method)) + + self.assertTrue(req.ok) + self.assertTrue(req.json(), dict) + + def test_002_pluginslist(self): + """Plugins list.""" + method = "pluginslist" + print('INFO: [TEST_002] Plugins list') + print("HTTP RESTful request: %s/%s" % (URL, method)) + req = self.http_get("%s/%s" % (URL, method)) + + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), list) + self.assertIn('cpu', req.json()) + + def test_003_plugins(self): + """Plugins.""" + method = "pluginslist" + print('INFO: [TEST_003] Plugins') + plist = self.http_get("%s/%s" % (URL, method)) + + for p in plist.json(): + print("HTTP RESTful request: %s/%s" % (URL, p)) + req = self.http_get("%s/%s" % (URL, p)) + self.assertTrue(req.ok) + if p in ('uptime', 'version', 'psutilversion'): + self.assertIsInstance(req.json(), text_type) + elif p in ('fs', 'percpu', 'sensors', 'alert', 'processlist', 'diskio', + 'hddtemp', 'batpercent', 'network', 'folders', 'amps', 'ports', + 'irq', 'wifi', 'gpu', 'containers'): + self.assertIsInstance(req.json(), list) + if len(req.json()) > 0: + self.assertIsInstance(req.json()[0], dict) + else: + self.assertIsInstance(req.json(), dict) + + def test_004_items(self): + """Items.""" + method = "cpu" + print('INFO: [TEST_004] Items for the CPU method') + ilist = self.http_get("%s/%s" % (URL, method)) + + for i in ilist.json(): + print("HTTP RESTful request: %s/%s/%s" % (URL, method, i)) + req = self.http_get("%s/%s/%s" % (URL, method, i)) + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), dict) + print(req.json()[i]) + self.assertIsInstance(req.json()[i], numbers.Number) + + def test_005_values(self): + """Values.""" + method = "processlist" + print('INFO: [TEST_005] Item=Value for the PROCESSLIST method') + print("%s/%s/pid/0" % (URL, method)) + req = self.http_get("%s/%s/pid/0" % (URL, method)) + + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), dict) + + def test_006_all_limits(self): + """All limits.""" + method = "all/limits" + print('INFO: [TEST_006] Get all limits') + print("HTTP RESTful request: %s/%s" % (URL, method)) + req = self.http_get("%s/%s" % (URL, method)) + + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), dict) + + def test_007_all_views(self): + """All views.""" + method = "all/views" + print('INFO: [TEST_007] Get all views') + print("HTTP RESTful request: %s/%s" % (URL, method)) + req = self.http_get("%s/%s" % (URL, method)) + + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), dict) + + def test_008_plugins_limits(self): + """Plugins limits.""" + method = "pluginslist" + print('INFO: [TEST_008] Plugins limits') + plist = self.http_get("%s/%s" % (URL, method)) + + for p in plist.json(): + print("HTTP RESTful request: %s/%s/limits" % (URL, p)) + req = self.http_get("%s/%s/limits" % (URL, p)) + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), dict) + + def test_009_plugins_views(self): + """Plugins views.""" + method = "pluginslist" + print('INFO: [TEST_009] Plugins views') + plist = self.http_get("%s/%s" % (URL, method)) + + for p in plist.json(): + print("HTTP RESTful request: %s/%s/views" % (URL, p)) + req = self.http_get("%s/%s/views" % (URL, p)) + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), dict) + + def test_010_history(self): + """History.""" + method = "history" + print('INFO: [TEST_010] History') + print("HTTP RESTful request: %s/cpu/%s" % (URL, method)) + req = self.http_get("%s/cpu/%s" % (URL, method)) + self.assertIsInstance(req.json(), dict) + self.assertIsInstance(req.json()['user'], list) + self.assertTrue(len(req.json()['user']) > 0) + print("HTTP RESTful request: %s/cpu/%s/3" % (URL, method)) + req = self.http_get("%s/cpu/%s/3" % (URL, method)) + self.assertIsInstance(req.json(), dict) + self.assertIsInstance(req.json()['user'], list) + self.assertTrue(len(req.json()['user']) > 1) + print("HTTP RESTful request: %s/cpu/system/%s" % (URL, method)) + req = self.http_get("%s/cpu/system/%s" % (URL, method)) + self.assertIsInstance(req.json(), list) + self.assertIsInstance(req.json()[0], list) + print("HTTP RESTful request: %s/cpu/system/%s/3" % (URL, method)) + req = self.http_get("%s/cpu/system/%s/3" % (URL, method)) + self.assertIsInstance(req.json(), list) + self.assertIsInstance(req.json()[0], list) + + def test_011_issue1401(self): + """Check issue #1401.""" + method = "network/interface_name" + print('INFO: [TEST_011] Issue #1401') + req = self.http_get("%s/%s" % (URL, method)) + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), dict) + self.assertIsInstance(req.json()['interface_name'], list) + + def test_012_status(self): + """Check status endpoint.""" + method = "status" + print('INFO: [TEST_012] Status') + print("HTTP RESTful request: %s/%s" % (URL, method)) + req = self.http_get("%s/%s" % (URL, method)) + + self.assertTrue(req.ok) + self.assertEqual(req.json()['version'], __version__) + + def test_013_top(self): + """Values.""" + method = "processlist" + request = "%s/%s/top/2" % (URL, method) + print('INFO: [TEST_013] Top nb item of PROCESSLIST') + print(request) + req = self.http_get(request) + + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), list) + self.assertEqual(len(req.json()), 2) + + def test_014_config(self): + """Test API request to get Glances configuration.""" + method = "config" + print('INFO: [TEST_014] Get config') + + req = self.http_get("%s/%s" % (URL, method)) + self.assertTrue(req.ok) + self.assertIsInstance(req.json(), dict) + + req = self.http_get("%s/%s/global/refresh" % (URL, method)) + self.assertTrue(req.ok) + self.assertEqual(req.json(), "2") + + def test_015_all_gzip(self): + """All with Gzip.""" + method = "all" + print('INFO: [TEST_015] Get all stats (with GZip compression)') + print("HTTP RESTful request: %s/%s" % (URL, method)) + req = self.http_get("%s/%s" % (URL, method), gzip=True) + + self.assertTrue(req.ok) + self.assertTrue(req.headers['Content-Encoding'] == 'gzip') + self.assertTrue(req.json(), dict) + + def test_016_fields_description(self): + """Fields description.""" + print('INFO: [TEST_016] Get fields description and unit') + + print("HTTP RESTful request: %s/cpu/total/description" % URL) + req = self.http_get("%s/cpu/total/description" % URL) + self.assertTrue(req.ok) + self.assertTrue(req.json(), str) + + print("HTTP RESTful request: %s/cpu/total/unit" % URL) + req = self.http_get("%s/cpu/total/unit" % URL) + self.assertTrue(req.ok) + self.assertTrue(req.json(), str) + + def test_999_stop_server(self): + """Stop the Glances Web Server.""" + print('INFO: [TEST_999] Stop the Glances Web Server') + + print("Stop the Glances Web Server") + pid.terminate() + time.sleep(1) + + self.assertTrue(True) + + +if __name__ == '__main__': + unittest.main() |