1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
|
# -*- coding: utf-8 -*-
# SPDX-FileCopyrightText: 2014-2023 Greenbone AG
#
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Test module for command line arguments."""
import unittest
from unittest.mock import patch
from io import StringIO
from pathlib import Path
from typing import List
from ospd.parser import (
DEFAULT_MQTT_BROKER_ADDRESS,
DEFAULT_MQTT_BROKER_PORT,
Arguments,
DEFAULT_ADDRESS,
DEFAULT_PORT,
DEFAULT_KEY_FILE,
DEFAULT_NICENESS,
DEFAULT_SCANINFO_STORE_TIME,
DEFAULT_UNIX_SOCKET_PATH,
DEFAULT_PID_PATH,
DEFAULT_LOCKFILE_DIR_PATH,
)
from ospd_openvas.notus import NotusParser
here = Path(__file__).absolute().parent
class ArgumentParserTestCase(unittest.TestCase):
def setUp(self):
self.parser = NotusParser()
def parse_args(self, args: List[str]) -> Arguments:
return self.parser.parse_arguments(args)
@patch('sys.stderr', new_callable=StringIO)
def test_port_interval(self, _mock_stderr):
with self.assertRaises(SystemExit):
self.parse_args(['--port=65536'])
with self.assertRaises(SystemExit):
self.parse_args(['--port=0'])
args = self.parse_args(['--port=3353'])
self.assertEqual(3353, args.port)
@patch('sys.stderr', new_callable=StringIO)
def test_port_as_string(self, _mock_stderr):
with self.assertRaises(SystemExit):
self.parse_args(['--port=abcd'])
def test_address_param(self):
args = self.parse_args('-b 1.2.3.4'.split())
self.assertEqual('1.2.3.4', args.address)
def test_correct_lower_case_log_level(self):
args = self.parse_args('-L error'.split())
self.assertEqual('ERROR', args.log_level)
def test_correct_upper_case_log_level(self):
args = self.parse_args('-L INFO'.split())
self.assertEqual('INFO', args.log_level)
@patch('sys.stderr', new_callable=StringIO)
def test_correct_log_level(self, _mock_stderr):
with self.assertRaises(SystemExit):
self.parse_args('-L blah'.split())
def test_non_existing_key(self):
args = self.parse_args('-k foo'.split())
self.assertEqual('foo', args.key_file)
def test_existing_key(self):
args = self.parse_args('-k /etc/passwd'.split())
self.assertEqual('/etc/passwd', args.key_file)
def test_disable_notus_hashsum_verification(self):
args = self.parse_args(
'--disable-notus-hashsum-verification true'.split()
)
self.assertEqual(args.disable_notus_hashsum_verification, True)
def test_defaults(self):
args = self.parse_args([])
self.assertIsNone(args.config)
self.assertEqual(args.key_file, DEFAULT_KEY_FILE)
self.assertEqual(args.niceness, DEFAULT_NICENESS)
self.assertEqual(args.log_level, 'INFO')
self.assertEqual(args.address, DEFAULT_ADDRESS)
self.assertEqual(args.port, DEFAULT_PORT)
self.assertEqual(args.scaninfo_store_time, DEFAULT_SCANINFO_STORE_TIME)
self.assertEqual(args.unix_socket, DEFAULT_UNIX_SOCKET_PATH)
self.assertEqual(args.pid_file, DEFAULT_PID_PATH)
self.assertEqual(args.lock_file_dir, DEFAULT_LOCKFILE_DIR_PATH)
self.assertEqual(args.mqtt_broker_address, DEFAULT_MQTT_BROKER_ADDRESS)
self.assertEqual(args.mqtt_broker_port, DEFAULT_MQTT_BROKER_PORT)
self.assertEqual(args.disable_notus_hashsum_verification, False)
class ArgumentParserConfigTestCase(unittest.TestCase):
def setUp(self):
self.parser = NotusParser()
def parse_args(self, args: List[str]) -> Arguments:
return self.parser.parse_arguments(args)
def test_using_config(self):
config_file = str(here / 'testing.conf')
args = self.parse_args(['--config', config_file])
self.assertEqual(args.key_file, '/foo/key.pem')
self.assertEqual(args.niceness, 666)
self.assertEqual(args.log_level, 'DEBUG')
self.assertEqual(args.address, '6.6.6.6')
self.assertEqual(args.port, 6666)
self.assertEqual(args.scaninfo_store_time, 123)
self.assertEqual(args.config, config_file)
self.assertEqual(args.unix_socket, '/foo/ospd-openvas.sock')
self.assertEqual(args.pid_file, '/foo/ospd-openvas.pid')
self.assertEqual(args.lock_file_dir, '/foo/openvas')
self.assertEqual(args.mqtt_broker_address, 'foo.bar.com')
self.assertEqual(args.mqtt_broker_port, 1234)
self.assertEqual(args.notus_feed_dir, '/foo/advisories')
@patch('sys.stderr', new_callable=StringIO)
def test_not_existing_config(self, _mock):
with self.assertRaises(SystemExit):
self.parse_args(['--config', 'foo.conf'])
|