File: test_extension.py

package info (click to toggle)
azure-devops-cli-extension 1.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,384 kB
  • sloc: python: 160,782; xml: 198; makefile: 56; sh: 51
file content (149 lines) | stat: -rw-r--r-- 7,263 bytes parent folder | download
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

import unittest

try:
    # Attempt to load mock (works on Python 3.3 and above)
    from unittest.mock import patch
except ImportError:
    # Attempt to load mock (works on Python version below 3.3)
    from mock import patch

from azext_devops.devops_sdk.v5_0.extension_management.extension_management_client import ExtensionManagementClient
from azext_devops.dev.team.extension import  (list_extensions,
                                              get_extension,
                                              install_extension,
                                              uninstall_extension,
                                              enable_extension,
                                              disable_extension)

from azext_devops.dev.common.services import clear_connection_cache
from azext_devops.tests.utils.authentication import AuthenticatedTests

class MockInstalledExtension(object):
    def __init__(self, flags, install_state=None):
        self.flags = flags
        self.install_state = install_state
    
class TestExtensionMethods(AuthenticatedTests):

    _TEST_DEVOPS_ORGANIZATION = 'https://someorganization.visualstudio.com'
    _EXT_MGMT_CLIENT_LOCATION = 'azext_devops.devops_sdk.v5_0.extension_management.extension_management_client.ExtensionManagementClient.'

    def setUp(self):
        self.authentication_setup()
        self.get_client = patch('azext_devops.devops_sdk.connection.Connection.get_client')
        self.get_installed_extensions_patcher = patch(self._EXT_MGMT_CLIENT_LOCATION + 'get_installed_extensions')
        self.get_installed_extension_patcher = patch(self._EXT_MGMT_CLIENT_LOCATION + 'get_installed_extension_by_name')
        self.install_extension_patcher = patch(self._EXT_MGMT_CLIENT_LOCATION + 'install_extension_by_name')
        self.uninstall_extension_patcher = patch(self._EXT_MGMT_CLIENT_LOCATION + 'uninstall_extension_by_name')
        self.update_installed_extension_patcher = patch(self._EXT_MGMT_CLIENT_LOCATION + 'update_installed_extension')

        #start the patcher
        self.mock_get_client = self.get_client.start()
        self.mock_get_installed_extensions = self.get_installed_extensions_patcher.start()
        self.mock_get_installed_extension = self.get_installed_extension_patcher.start()
        self.mock_install_extension = self.install_extension_patcher.start()
        self.mock_uninstall_extension = self.uninstall_extension_patcher.start()
        self.mock_update_installed_extension = self.update_installed_extension_patcher.start()

        #set return values
        self.mock_get_client.return_value = ExtensionManagementClient(base_url=self._TEST_DEVOPS_ORGANIZATION)

        #clear connection cache before running each test
        clear_connection_cache()

    def tearDown(self):
        patch.stopall()
        

    def test_list_extensions(self):
        list_extensions(False,False,self._TEST_DEVOPS_ORGANIZATION, False)
                
        #assert
        self.mock_get_installed_extensions.assert_called_once_with(include_disabled_extensions=False)

    def test_list_extensions_include_disabled_extension(self):
        list_extensions(False,True,self._TEST_DEVOPS_ORGANIZATION, False)
                
        #assert
        self.mock_get_installed_extensions.assert_called_once_with(include_disabled_extensions=True)

    def test_list_extension_include_builtin_extension(self):
        extensions = []
        extensions.append(MockInstalledExtension('builtIn, installed'))
        extensions.append(MockInstalledExtension('builtIn, installed'))
        extensions.append(MockInstalledExtension('installed'))

        self.mock_get_installed_extensions.return_value = extensions

        result = list_extensions(True,True,self._TEST_DEVOPS_ORGANIZATION, False)

        self.assertEqual(len(result), 3)

    def test_list_extension_not_include_builtin_extension(self):
        extensions = []
        extensions.append(MockInstalledExtension('builtIn, installed'))
        extensions.append(MockInstalledExtension('builtIn, installed'))
        extensions.append(MockInstalledExtension('installed'))

        self.mock_get_installed_extensions.return_value = extensions

        result = list_extensions(False,False,self._TEST_DEVOPS_ORGANIZATION, False)

        self.assertEqual(len(result), 1)

    def test_get_extension(self):
        get_extension('ms', 'code-search', self._TEST_DEVOPS_ORGANIZATION)

        self.mock_get_installed_extension.assert_called_once_with(publisher_name='ms', extension_name='code-search')

    def test_install_extension(self):
        install_extension('ms', 'code-search', self._TEST_DEVOPS_ORGANIZATION)

        self.mock_install_extension.assert_called_once_with(publisher_name='ms', extension_name='code-search')
        
    def test_uninstall_extension(self):
        uninstall_extension('ms', 'code-search', self._TEST_DEVOPS_ORGANIZATION)

        self.mock_uninstall_extension.assert_called_once_with(publisher_name='ms', extension_name='code-search')

    def test_enable_extension(self):
        extension = MockInstalledExtension('builtIn', MockInstalledExtension('disabled , buildIn , multiVersion'))
        self.mock_get_installed_extension.return_value = extension

        enable_extension('ms', 'code-search', self._TEST_DEVOPS_ORGANIZATION)

        self.mock_update_installed_extension.assert_called_once()
        udpate_extension_object = self.mock_update_installed_extension.call_args_list[0][0]
        install_state_flags = udpate_extension_object[0].install_state.flags
        self.assertEqual('buildIn, multiVersion', install_state_flags)

    def test_enable_extension_disabled_not_first(self):
        extension = MockInstalledExtension('builtIn', MockInstalledExtension('buildIn , multiVersion , disabled'))
        self.mock_get_installed_extension.return_value = extension

        enable_extension('ms', 'code-search', self._TEST_DEVOPS_ORGANIZATION)

        self.mock_update_installed_extension.assert_called_once()
        udpate_extension_object = self.mock_update_installed_extension.call_args_list[0][0]
        install_state_flags = udpate_extension_object[0].install_state.flags
        self.assertEqual('buildIn, multiVersion', install_state_flags)


    def test_disable_extension(self):
        extension = MockInstalledExtension('builtIn', MockInstalledExtension('buildIn, multiVersion'))
        self.mock_get_installed_extension.return_value = extension

        disable_extension('ms', 'code-search', self._TEST_DEVOPS_ORGANIZATION)

        self.mock_update_installed_extension.assert_called_once()
        udpate_extension_object = self.mock_update_installed_extension.call_args_list[0][0]
        install_state_flags = udpate_extension_object[0].install_state.flags
        self.assertEqual('buildIn, multiVersion, disabled', install_state_flags)

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