File: test_security_permission.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 (220 lines) | stat: -rw-r--r-- 12,653 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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
import json
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.security.security_client import (SecurityClient)
from azext_devops.devops_sdk.v5_0.security.models import (AccessControlList,
                                                          AccessControlEntry,
                                                          AceExtendedInformation,
                                                          ActionDefinition,
                                                          SecurityNamespaceDescription)
from azext_devops.dev.team.security_permission import (list_namespaces,
                                                       show_namespace,
                                                       list_tokens,
                                                       show_permissions,
                                                       reset_all_permissions,
                                                       reset_permissions,
                                                       update_permissions,
                                                       _resolve_bits)

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

class TestSecurityPermissionsMethods(AuthenticatedTests):
    _TEST_DEVOPS_ORGANIZATION = 'https://someorganization.visualstudio.com'
    _SECURITY_CLIENT_LOCATION = 'azext_devops.devops_sdk.v5_0.security.security_client.SecurityClient.'
    _TEST_GROUP_DESCRIPTOR = 'vssgp.someRandomDescriptorForGroup'
    _TEST_GROUP_NAME = 'New test security group'
    _TEST_SECURITY_TOKEN = 'some_security_token'
    _TEST_IDENTITY_DESCRIPTOR = 'Microsoft.Identity.aaaaaaaa'
    _TEST_SECURITY_NAMESPACE_ID = 'bf7bfa03-b2b7-47db-xxxx-fa2e002xxxx'

    def setUp(self):
        self.authentication_setup()
        self.authenticate()
        
        self.list_namespaces_patcher = patch(self._SECURITY_CLIENT_LOCATION + 'query_security_namespaces')
        self.list_acl_patcher = patch(self._SECURITY_CLIENT_LOCATION + 'query_access_control_lists')
        self.remove_ace_patcher = patch(self._SECURITY_CLIENT_LOCATION + 'remove_access_control_entries')
        self.set_ace_patcher = patch(self._SECURITY_CLIENT_LOCATION + 'set_access_control_entries')
        self.remove_permission_patcher = patch(self._SECURITY_CLIENT_LOCATION + 'remove_permission')
        self.get_identity_descriptor_patcher = patch('azext_devops.dev.team.security_permission._resolve_subject_as_identity_descriptor')
        self.resolve_bits_patcher = patch('azext_devops.dev.team.security_permission._resolve_bits')
        self.get_client = patch('azext_devops.devops_sdk.connection.Connection.get_client')

        self.mock_get_client = self.get_client.start()
        self.mock_get_identity_descriptor = self.get_identity_descriptor_patcher.start()
        self.mock_list_namespaces = self.list_namespaces_patcher.start()
        self.mock_list_acl = self.list_acl_patcher.start()
        self.mock_resolve_bits = self.resolve_bits_patcher.start()
        self.mock_set_ace = self.set_ace_patcher.start()
        self.mock_remove_permission = self.remove_permission_patcher.start()
        self.mock_remove_ace = self.remove_ace_patcher.start()
        #set return values
        self.mock_get_client.return_value = SecurityClient(base_url=self._TEST_DEVOPS_ORGANIZATION)
        self.mock_get_identity_descriptor.return_value = self._TEST_IDENTITY_DESCRIPTOR
        #clear connection cache before running each test
        clear_connection_cache()

    def tearDown(self):
        patch.stopall()

    def test_list_namespaces(self):
        response = list_namespaces(False,organization=self._TEST_DEVOPS_ORGANIZATION)
        #assert
        self.mock_list_namespaces.assert_called_once()
        list_namespaces_param = self.mock_list_namespaces.call_args_list[0][1]
        self.assertEqual(False, list_namespaces_param['local_only'])
    
    def test_show_namespace(self):
        response = show_namespace(namespace_id=self._TEST_SECURITY_NAMESPACE_ID,organization=self._TEST_DEVOPS_ORGANIZATION)
        #assert
        self.mock_list_namespaces.assert_called_once()
        show_namespace_param = self.mock_list_namespaces.call_args_list[0][1]
        self.assertEqual(self._TEST_SECURITY_NAMESPACE_ID, show_namespace_param['security_namespace_id'])
    
    def test_list_tokens(self):
        response = list_tokens(namespace_id=self._TEST_SECURITY_NAMESPACE_ID,
                                subject = self._TEST_GROUP_DESCRIPTOR, 
                                recurse=False,organization=self._TEST_DEVOPS_ORGANIZATION)
        #assert
        self.mock_list_acl.assert_called_once()
        list_tokens_param = self.mock_list_acl.call_args_list[0][1]
        self.assertEqual(self._TEST_SECURITY_NAMESPACE_ID, list_tokens_param['security_namespace_id'])
        self.assertEqual(False, list_tokens_param['recurse'])
        self.assertEqual(True, list_tokens_param['include_extended_info'])
        self.assertEqual(self._TEST_IDENTITY_DESCRIPTOR, list_tokens_param['descriptors'])
        
    def test_show_permissions(self):
        self.mock_resolve_bits.return_value = self._get_resolve_bits_response()
        response = show_permissions(namespace_id=self._TEST_SECURITY_NAMESPACE_ID,
                                    subject = self._TEST_GROUP_DESCRIPTOR, 
                                    token= self._TEST_SECURITY_TOKEN,
                                    organization=self._TEST_DEVOPS_ORGANIZATION)
        #assert
        self.mock_list_acl.assert_called_once()
        show_permissions_param = self.mock_list_acl.call_args_list[0][1]
        self.assertEqual(self._TEST_SECURITY_NAMESPACE_ID, show_permissions_param['security_namespace_id'])
        self.assertEqual(False, show_permissions_param['recurse'])
        self.assertEqual(self._TEST_SECURITY_TOKEN, show_permissions_param['token'])
        self.assertEqual(True, show_permissions_param['include_extended_info'])
        self.assertEqual(self._TEST_IDENTITY_DESCRIPTOR, show_permissions_param['descriptors'])

    def test_update_permissions(self):
        self.mock_resolve_bits.return_value = self._get_resolve_bits_response()       
        response = update_permissions(namespace_id=self._TEST_SECURITY_NAMESPACE_ID,
                                    allow_bit = 3,
                                    subject = self._TEST_GROUP_DESCRIPTOR, 
                                    token= self._TEST_SECURITY_TOKEN,
                                    organization=self._TEST_DEVOPS_ORGANIZATION,
                                    merge=True)
        #assert
        self.mock_list_acl.assert_called_once()
        self.mock_set_ace.assert_called_once()
        show_permissions_param = self.mock_list_acl.call_args_list[0][1]
        update_permissions_param = self.mock_set_ace.call_args_list[0][1]
        self.assertEqual(self._TEST_SECURITY_TOKEN, show_permissions_param['token'])
        self.assertEqual(self._TEST_SECURITY_NAMESPACE_ID, show_permissions_param['security_namespace_id'])
        self.assertEqual(self._TEST_IDENTITY_DESCRIPTOR, show_permissions_param['descriptors'])
        self.assertEqual(self._TEST_SECURITY_NAMESPACE_ID, update_permissions_param['security_namespace_id'])

    def test_reset_permissions(self):
        self.mock_resolve_bits.return_value = self._get_resolve_bits_response()
        response = reset_permissions(namespace_id=self._TEST_SECURITY_NAMESPACE_ID,
                                    permission_bit = 3,
                                    subject = self._TEST_GROUP_DESCRIPTOR, 
                                    token= self._TEST_SECURITY_TOKEN,
                                    organization=self._TEST_DEVOPS_ORGANIZATION)
        #assert
        self.mock_list_acl.assert_called_once()
        self.mock_remove_permission.assert_called_once()
        show_permissions_param = self.mock_list_acl.call_args_list[0][1]
        remove_permissions_param = self.mock_remove_permission.call_args_list[0][1]
        self.assertEqual(self._TEST_SECURITY_TOKEN, show_permissions_param['token'])
        self.assertEqual(self._TEST_SECURITY_NAMESPACE_ID, show_permissions_param['security_namespace_id'])
        self.assertEqual(self._TEST_IDENTITY_DESCRIPTOR, show_permissions_param['descriptors'])
        self.assertEqual(self._TEST_SECURITY_NAMESPACE_ID, remove_permissions_param['security_namespace_id'])
        self.assertEqual(3, remove_permissions_param['permissions'])
        self.assertEqual(self._TEST_IDENTITY_DESCRIPTOR, remove_permissions_param['descriptor'])
        self.assertEqual(self._TEST_SECURITY_TOKEN, remove_permissions_param['token'])

    def test_reset_all_permissions(self):
        response = reset_all_permissions(namespace_id=self._TEST_SECURITY_NAMESPACE_ID,
                                         subject = self._TEST_GROUP_DESCRIPTOR,
                                         token = self._TEST_SECURITY_TOKEN,
                                         organization=self._TEST_DEVOPS_ORGANIZATION)
        #assert
        self.mock_remove_ace.assert_called_once()
        remove_ace_param = self.mock_remove_ace.call_args_list[0][1]
        self.assertEqual(self._TEST_SECURITY_NAMESPACE_ID, remove_ace_param['security_namespace_id'])
        self.assertEqual(self._TEST_SECURITY_TOKEN, remove_ace_param['token'])
        self.assertEqual(self._TEST_IDENTITY_DESCRIPTOR, remove_ace_param['descriptors'])

    def _get_resolve_bits_response(self,changed_bits=0):
        # api response
        namespace_details = self._create_namespace_details_response()
        acl_response = self._create_permission_api_response()
        resolved_bits_response = _resolve_bits(acl_response, namespace_details,changed_bits=changed_bits)
        return resolved_bits_response
    
    def _create_namespace_details_response(self):
        #namespace list reponse
        namespace_details = []
        namespace_details_entry = SecurityNamespaceDescription()
        dummy_actions = []
        # GENERIC_READ
        readAction = ActionDefinition()
        readAction.bit = 1
        readAction.displayName = 'View Resource'
        readAction.name = 'GENERIC_READ'
        readAction.namespace_id = self._TEST_SECURITY_NAMESPACE_ID
        dummy_actions.append(readAction)
        # GENERIC_WRITE
        writeAction = ActionDefinition()
        writeAction.bit = 2
        writeAction.displayName = 'Create Resource'
        writeAction.name = 'GENERIC_WRITE'
        writeAction.namespace_id = self._TEST_SECURITY_NAMESPACE_ID
        dummy_actions.append(writeAction)
        # GENERIC_UPDATE
        updateAction = ActionDefinition()
        updateAction.bit = 4
        updateAction.displayName = 'Update Resource'
        updateAction.name = 'GENERIC_UPDATE'
        updateAction.namespace_id = self._TEST_SECURITY_NAMESPACE_ID
        dummy_actions.append(updateAction)
        namespace_details_entry.actions = dummy_actions
        namespace_details.append(namespace_details_entry)
        return namespace_details

    def _create_permission_api_response(self, allow_bit=0, deny_bit=0, effective_allow=0, effective_deny=0):
        acl_response = []
        acl_entry = AccessControlList()
        ace_dictionary = {}
        ace_entry = AccessControlEntry()
        ace_entry.allow = allow_bit
        ace_entry.deny = deny_bit
        ace_entry.descriptor = self._TEST_IDENTITY_DESCRIPTOR
        extended_info = AceExtendedInformation()
        extended_info.effective_allow = effective_allow
        extended_info.effective_deny = effective_deny
        ace_entry.extended_info = extended_info
        ace_dictionary[self._TEST_IDENTITY_DESCRIPTOR] = ace_entry
        acl_entry.aces_dictionary = ace_dictionary
        acl_entry.include_extended_info = True
        acl_entry.inherit_permissions = False
        acl_entry.token = self._TEST_SECURITY_TOKEN
        acl_response.append(acl_entry)
        return acl_response