tests.test_gmp_protocol.GMPCreateTaskCommandTestCase.setUp() - Code Metrics - Inspection of "Merge pull request #59 from hacker-h/issue/58" - greenbone/gvm-tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a2d5c6...0c7412 )

by Juan José

created 2018-10-16 11:28 UTC

tests.test_gmp_protocol.GMPCreateTaskCommandTestCase.setUp() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines	2
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0

# -*- coding: utf-8 -*-
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
# Description:
# Testcases to test gmp protocol
#
# Authors:
# Michael Wiegand <[email protected]>
#
# Copyright:
# Copyright (C) 2018 Greenbone Networks GmbH
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import unittest
from gmp.gmp import _gmp

class GMPCreateTaskCommandTestCase(unittest.TestCase):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

    TASK_NAME = "important task"
    CONFIG_ID = "cd0641e7-40b8-4e2c-811e-6b39d6d4b904"
    TARGET_ID = '267a3405-e84a-47da-97b2-5fa0d2e8995e'
    SCANNER_ID = 'b64c81b2-b9de-11e3-a2e9-406186ea4fc5'
    ALERT_ID = '3ab38c6a-30ac-407a-98db-ad6e74c98b9a'
    COMMENT = 'this task has been created for test purposes'

    def setUp(self):
        self.gmp = _gmp()

    def test_WithoutAlert_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTaskCommand(
            self.TASK_NAME, self.CONFIG_ID, self.TARGET_ID, self.SCANNER_ID, comment=self.COMMENT)

        self.assertEqual('<create_task><name>{0}</name><comment>{1}</comment>' \
                         '<config id="{2}"/><target id="{3}"/><scanner id="{4}"/>' \
                         '</create_task>'.format(self.TASK_NAME,
                         self.COMMENT, self.CONFIG_ID, self.TARGET_ID, self.SCANNER_ID), cmd)


    def test_SingleAlert_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTaskCommand(
            self.TASK_NAME, self.CONFIG_ID, self.TARGET_ID, self.SCANNER_ID,self.ALERT_ID, self.COMMENT)


        self.assertEqual('<create_task><name>{0}</name><comment>{1}</comment>' \
                         '<config id="{2}"/><target id="{3}"/><scanner id="{4}"/>' \
                         '<alert id="{5}"/></create_task>'.format(self.TASK_NAME,
                         self.COMMENT, self.CONFIG_ID, self.TARGET_ID, self.SCANNER_ID, self.ALERT_ID), cmd)


    def test_MultipleAlerts_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        alert_id2 = 'fb3d6f82-d706-4f99-9e53-d7d85257e25f'
        alert_id3 = 'a33864a9-d3fd-44b3-8717-972bfb01dfcf'
        alert_ids = [self.ALERT_ID, alert_id2, alert_id3]
        cmd = self.gmp.createTaskCommand(
            self.TASK_NAME, self.CONFIG_ID, self.TARGET_ID, self.SCANNER_ID, alert_ids, self.COMMENT)

        self.assertEqual('<create_task><name>{0}</name><comment>{1}</comment>' \
                         '<config id="{2}"/><target id="{3}"/><scanner id="{4}"/>' \
                         '<alert id="{5}"/><alert id="{6}"/><alert id="{7}"/>' \
                         '</create_task>'.format(self.TASK_NAME,
                         self.COMMENT, self.CONFIG_ID, self.TARGET_ID, self.SCANNER_ID, self.ALERT_ID,

                         alert_id2, alert_id3), cmd)


class GMPCreateTargetCommandTestCase(unittest.TestCase):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    TARGET_NAME = 'Unittest Target'
    TARGET_HOST = '127.0.0.1'
    COMMENT = 'This is a comment'
    UUID = '00000000-0000-0000-0000-000000000000'
    PORT = '1234'
    ALIVE_TEST = 'ICMP Ping'
    PORT_RANGE = 'T:10-20,U:10-30'

    def setUp(self):
        self.gmp = _gmp()

    def tearDown(self):
        pass

    def test_ValidNameMakeUniqueTrue_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                                           True,
                                           {'hosts': self.TARGET_HOST})

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                         '<make_unique>1</make_unique></name>'
                         '<hosts>' + self.TARGET_HOST + '</hosts>'
                         '</create_target>', cmd)

    def test_ValidNameMakeUniqueFalse_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                                           False,
                                           {'hosts': self.TARGET_HOST})

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                         '<make_unique>0</make_unique></name>'
                         '<hosts>' + self.TARGET_HOST + '</hosts>'
                         '</create_target>', cmd)

    def test_EmptyName_ValueError(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        with self.assertRaises(ValueError) as context:
            self.gmp.createTargetCommand("", True, {'hosts': self.TARGET_HOST})

        self.assertEqual('create_target requires a name element',
                         str(context.exception))

    def test_AssetHosts_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {'asset_hosts': {'filter': self.TARGET_HOST}})


        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<asset_hosts filter="' + self.TARGET_HOST + '"/>'
                '</create_target>',

                cmd)


    def test_NoHostNoAssetHosts_ValueError(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        with self.assertRaises(ValueError) as context:
            self.gmp.createTargetCommand(self.TARGET_NAME, True, {})

        self.assertEqual('create_target requires either a hosts or '
                         'an asset_hosts element',
                         str(context.exception))

    def test_Comment_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'comment': self.COMMENT
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<comment>' + self.COMMENT + '</comment>'

                '</create_target>',

                cmd)


    def test_Copy_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'copy': self.UUID
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<copy>' + self.UUID + '</copy>'

                '</create_target>',

                cmd)


    def test_ExcludeHosts_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'exclude_hosts': self.TARGET_HOST
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<exclude_hosts>' + self.TARGET_HOST + '</exclude_hosts>'

                '</create_target>',

                cmd)


    def test_SSHCredential_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'ssh_credential':
                    {
                        'id': self.UUID
                        }
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<ssh_credential id="' + self.UUID + '"></ssh_credential>'

                '</create_target>',

                cmd)


    def test_SSHCredentialWithPort_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'ssh_credential':
                    {
                        'id': self.UUID,
                        'port': self.PORT
                        }
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<ssh_credential id="' + self.UUID + '">'

                '<port>' + self.PORT + '</port></ssh_credential>'

                '</create_target>',

                cmd)


    def test_SSHCredentialNoID_ValueError(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        with self.assertRaises(ValueError) as context:
            self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'ssh_credential': {}
                    })

        self.assertEqual('ssh_credential requires an id attribute',
                str(context.exception))


    def test_SMBCredential_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'smb_credential':
                    {
                        'id': self.UUID
                        }
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<smb_credential id="' + self.UUID + '"/>'

                '</create_target>',

                cmd)


    def test_SMBCredentialNoID_ValueError(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        with self.assertRaises(ValueError) as context:
            self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'smb_credential': {}
                    })

        self.assertEqual('smb_credential requires an id attribute',
                str(context.exception))


    def test_ESXiCredential_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'esxi_credential':
                    {
                        'id': self.UUID
                        }
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<esxi_credential id="' + self.UUID + '"/>'

                '</create_target>',

                cmd)


    def test_ESXiCredentialNoID_ValueError(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        with self.assertRaises(ValueError) as context:
            self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'esxi_credential': {}
                    })

        self.assertEqual('esxi_credential requires an id attribute',
                str(context.exception))


    def test_SNMPCredential_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'snmp_credential':
                    {
                        'id': self.UUID
                        }
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<snmp_credential id="' + self.UUID + '"/>'

                '</create_target>',

                cmd)


    def test_SNMPCredentialNoID_ValueError(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        with self.assertRaises(ValueError) as context:
            self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'snmp_credential': {}
                    })

        self.assertEqual('snmp_credential requires an id attribute',
                str(context.exception))


    def test_AliveTests_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'alive_tests': self.ALIVE_TEST
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<alive_tests>' + self.ALIVE_TEST + '</alive_tests>'

                '</create_target>',

                cmd)


    def test_ReverseLookupOnlyTrue_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'reverse_lookup_only': True
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<reverse_lookup_only>1</reverse_lookup_only>'

                '</create_target>',
                cmd)


    def test_ReverseLookupOnlyFalse_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'reverse_lookup_only': False
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<reverse_lookup_only>0</reverse_lookup_only>'

                '</create_target>',
                cmd)


    def test_ReverseLookupUnifyTrue_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'reverse_lookup_unify': True
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<reverse_lookup_unify>1</reverse_lookup_unify>'

                '</create_target>',
                cmd)


    def test_ReverseLookupUnifyFalse_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'reverse_lookup_unify': False
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<reverse_lookup_unify>0</reverse_lookup_unify>'

                '</create_target>',
                cmd)


    def test_PortRange_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'port_range': self.PORT_RANGE
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<port_range>' + self.PORT_RANGE + '</port_range>'

                '</create_target>',

                cmd)


    def test_PortList_CorrectCmd(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'port_list':
                    {
                        'id': self.UUID
                        }
                    })

        self.assertEqual('<create_target><name>' + self.TARGET_NAME +
                '<make_unique>1</make_unique></name>'

                '<hosts>' + self.TARGET_HOST + '</hosts>'
                '<port_list id="' + self.UUID + '"/>'

                '</create_target>',

                cmd)


    def test_PortListNoID_ValueError(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        with self.assertRaises(ValueError) as context:
            self.gmp.createTargetCommand(self.TARGET_NAME,
                True,

                {

                    'hosts': self.TARGET_HOST,
                    'port_list': {}
                    })

        self.assertEqual('port_list requires an id attribute',
                str(context.exception))



class GMPCreateReportCommandTestCase(unittest.TestCase):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    TASK_ID = '00000000-0000-0000-0000-000000000001'
    TASK_NAME = 'unit test task'
    COMMENT = 'This is a comment'
    REPORT_XML_STRING = (
        '<report id="67a62fb7-b238-4f0e-bc48-59bde8939cdc"><results max="1"' +
        ' start="1"><result id="f180b40f-49dd-4856-81ed-8c1195afce80">' +
        '<severity>0.0</severity><nvt oid="1.3.6.1.4.1.25623.1.0.10330"/>' +
        '<host>132.67.253.114</host></result></results></report>'
    )

    def setUp(self):
        self.gmp = _gmp()

    def tearDown(self):
        pass

    def test_Create_ReportCmd_Taskid(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createReportCommand(self.REPORT_XML_STRING,
                                           {
                                               'task_id': self.TASK_ID,
                                           })

        self.assertEqual('<create_report><task id="' + self.TASK_ID + '"/>' +
                         self.REPORT_XML_STRING + '</create_report>',
                         cmd)

    def test_Create_ReportCmd_Taskname(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp.createReportCommand(self.REPORT_XML_STRING,
                                           {
                                               'task_name': self.TASK_NAME,
                                               'comment': self.COMMENT,
                                           })

        self.assertEqual('<create_report><task>' +
                         '<name>' + self.TASK_NAME + '</name>' +
                         '<comment>' + self.COMMENT + '</comment>' +
                         '</task>' + self.REPORT_XML_STRING + '</create_report>',
                         cmd)

    def test_Create_ReportCmd_noreport(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        NO_REPORT = None

        args = {
            'task_name': self.TASK_NAME,
            'comment': self.COMMENT,
        }

        self.assertRaises(ValueError,
                          self.gmp.createReportCommand,
                          NO_REPORT,
                          args
        )


    def test_Create_ReportCmd_notask(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        args = {'comment': self.COMMENT}
        self.assertRaises(ValueError,
                          self.gmp.createReportCommand,
                          self.REPORT_XML_STRING,
                          args
        )


if __name__ == '__main__':
    unittest.main()


1			# -- coding: utf-8 --
			0 ignored issues – show Coding Style introduced 2018-06-12 10:47 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2			# Description:
3			# Testcases to test gmp protocol
4			#
5			# Authors:
6			# Michael Wiegand <[email protected]>
7			#
8			# Copyright:
9			# Copyright (C) 2018 Greenbone Networks GmbH
10			#
11			# This program is free software: you can redistribute it and/or modify
12			# it under the terms of the GNU General Public License as published by
13			# the Free Software Foundation, either version 3 of the License, or
14			# (at your option) any later version.
15			#
16			# This program is distributed in the hope that it will be useful,
17			# but WITHOUT ANY WARRANTY; without even the implied warranty of
18			# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			# GNU General Public License for more details.
20			#
21			# You should have received a copy of the GNU General Public License
22			# along with this program. If not, see <http://www.gnu.org/licenses/>.
23
24			import unittest
25			from gmp.gmp import _gmp
26
27			class GMPCreateTaskCommandTestCase(unittest.TestCase):
			0 ignored issues – show Coding Style introduced 2018-06-12 10:47 UTC by Report Bug Copy Issue Report This class should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history... Unused Code introduced 2018-06-12 10:47 UTC by Report Bug Copy Issue Report The variable `__class__` seems to be unused. Loading history...
28
29			TASK_NAME = "important task"
30			CONFIG_ID = "cd0641e7-40b8-4e2c-811e-6b39d6d4b904"
31			TARGET_ID = '267a3405-e84a-47da-97b2-5fa0d2e8995e'
32			SCANNER_ID = 'b64c81b2-b9de-11e3-a2e9-406186ea4fc5'
33			ALERT_ID = '3ab38c6a-30ac-407a-98db-ad6e74c98b9a'
34			COMMENT = 'this task has been created for test purposes'
35
36			def setUp(self):
37			self.gmp = _gmp()
38

greenbone / gvm-tools

Push — master ( a2d5c6...0c7412 )

tests.test_gmp_protocol.GMPCreateTaskCommandTestCase.setUp() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like