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
|
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
import re
import logging
from msrest.service_client import ServiceClient
from msrest import Configuration, Deserializer
from msrest.exceptions import HttpOperationError
from ..user.user_manager import UserManager
from . import models
class OrganizationManager():
""" Manage DevOps organizations
Create or list existing organizations
Attributes:
config: url configuration
client: authentication client
dserialize: deserializer to process http responses into python classes
"""
def __init__(self, base_url='https://app.vssps.visualstudio.com', creds=None,
create_organization_url='https://app.vsaex.visualstudio.com'):
"""Inits OrganizationManager"""
self._creds = creds
self._config = Configuration(base_url=base_url)
self._client = ServiceClient(creds, self._config)
#need to make a secondary client for the creating organization as it uses a different base url
self._create_organization_config = Configuration(base_url=create_organization_url)
self._create_organization_client = ServiceClient(creds, self._create_organization_config)
self._list_region_config = Configuration(base_url='https://aex.dev.azure.com')
self._list_region_client = ServiceClient(creds, self._create_organization_config)
client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)}
self._deserialize = Deserializer(client_models)
self._user_mgr = UserManager(creds=self._creds)
def validate_organization_name(self, organization_name):
"""Validate an organization name by checking it does not already exist and that it fits name restrictions"""
if organization_name is None:
return models.ValidateAccountName(valid=False, message="The organization_name cannot be None")
if re.search("[^0-9A-Za-z-]", organization_name):
return models.ValidateAccountName(valid=False, message="""The name supplied contains forbidden characters.
Only alphanumeric characters and dashes are allowed.
Please try another organization name.""")
#construct url
url = '/_AzureSpsAccount/ValidateAccountName'
#construct query parameters
query_paramters = {}
query_paramters['accountName'] = organization_name
#construct header parameters
header_paramters = {}
header_paramters['Accept'] = 'application/json'
request = self._client.get(url, params=query_paramters)
response = self._client.send(request, headers=header_paramters)
# Handle Response
deserialized = None
if response.status_code // 100 != 2:
logging.error("GET %s", request.url)
logging.error("response: %s", response.status_code)
logging.error(response.text)
raise HttpOperationError(self._deserialize, response)
else:
deserialized = self._deserialize('ValidateAccountName', response)
return deserialized
def list_organizations(self):
"""List what organizations this user is part of"""
if not self._user_mgr.is_msa_account():
# Only need to do the one request as ids are the same
organizations = self._list_organizations_request(self._user_mgr.aad_id)
else:
# Need to do a request for each of the ids and then combine them (disabled)
#organizations_aad = self._list_organizations_request(self._user_mgr.aad_id, msa=False)
#organizations_msa = self._list_organizations_request(self._user_mgr.msa_id, msa=True)
#organizations = organizations_msa
# Overwrite merge aad organizations with msa organizations
#duplicated_aad_orgs = []
#for msa_org in organizations_msa.value:
# duplicated_aad_orgs.extend([
# o for o in organizations_aad.value if o.accountName == msa_org.accountName
# ])
#filtered_organizations_aad = [o for o in organizations_aad.value if (o not in duplicated_aad_orgs)]
#organizations.value += list(filtered_organizations_aad)
#organizations.count = len(organizations.value)
organizations = self._list_organizations_request(self._user_mgr.msa_id, msa=True)
return organizations
def _list_organizations_request(self, member_id, msa=False):
url = '/_apis/Commerce/Subscription'
query_paramters = {}
query_paramters['memberId'] = member_id
query_paramters['includeMSAAccounts'] = True
query_paramters['queryOnlyOwnerAccounts'] = True
query_paramters['inlcudeDisabledAccounts'] = False
query_paramters['providerNamespaceId'] = 'VisualStudioOnline'
#construct header parameters
header_parameters = {}
header_parameters['X-VSS-ForceMsaPassThrough'] = 'true' if msa else 'false'
header_parameters['Accept'] = 'application/json'
request = self._client.get(url, params=query_paramters)
response = self._client.send(request, headers=header_parameters)
# Handle Response
deserialized = None
if response.status_code // 100 != 2:
logging.error("GET %s", request.url)
logging.error("response: %s", response.status_code)
logging.error(response.text)
raise HttpOperationError(self._deserialize, response)
else:
deserialized = self._deserialize('Organizations', response)
return deserialized
def create_organization(self, region_code, organization_name):
"""Create a new organization for user"""
url = '/_apis/HostAcquisition/collections'
#construct query parameters
query_paramters = {}
query_paramters['collectionName'] = organization_name
query_paramters['preferredRegion'] = region_code
query_paramters['api-version'] = '4.0-preview.1'
#construct header parameters
header_paramters = {}
header_paramters['Accept'] = 'application/json'
header_paramters['Content-Type'] = 'application/json'
if self._user_mgr.is_msa_account():
header_paramters['X-VSS-ForceMsaPassThrough'] = 'true'
#construct the payload
payload = {}
payload['VisualStudio.Services.HostResolution.UseCodexDomainForHostCreation'] = 'true'
request = self._create_organization_client.post(url=url, params=query_paramters, content=payload)
response = self._create_organization_client.send(request, headers=header_paramters)
# Handle Response
deserialized = None
if response.status_code // 100 != 2:
logging.error("GET %s", request.url)
logging.error("response: %s", response.status_code)
logging.error(response.text)
raise HttpOperationError(self._deserialize, response)
else:
deserialized = self._deserialize('NewOrganization', response)
return deserialized
def list_regions(self):
"""List what regions organizations can exist in"""
# Construct URL
url = '/_apis/hostacquisition/regions'
#construct header parameters
header_paramters = {}
header_paramters['Accept'] = 'application/json'
# Construct and send request
request = self._list_region_client.get(url, headers=header_paramters)
response = self._list_region_client.send(request)
# Handle Response
deserialized = None
if response.status_code // 100 != 2:
logging.error("GET %s", request.url)
logging.error("response: %s", response.status_code)
logging.error(response.text)
raise HttpOperationError(self._deserialize, response)
else:
deserialized = self._deserialize('Regions', response)
return deserialized
def close_connection(self):
"""Close the sessions"""
self._client.close()
self._create_organization_client.close()
|
