-
Notifications
You must be signed in to change notification settings - Fork 46
/
seed_enterprise_devstack_data.py
354 lines (325 loc) · 13.7 KB
/
seed_enterprise_devstack_data.py
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
"""
Management command for assigning enterprise roles to existing enterprise users.
"""
import json
import logging
import textwrap
from django.contrib import auth
from django.contrib.sites.models import Site
from django.core.management.base import BaseCommand
from django.db.utils import IntegrityError
from django.utils.text import slugify
from enterprise.constants import (
ENTERPRISE_ADMIN_ROLE,
ENTERPRISE_CATALOG_ADMIN_ROLE,
ENTERPRISE_DASHBOARD_ADMIN_ROLE,
ENTERPRISE_DATA_API_ACCESS_GROUP,
ENTERPRISE_ENROLLMENT_API_ACCESS_GROUP,
ENTERPRISE_ENROLLMENT_API_ADMIN_ROLE,
ENTERPRISE_LEARNER_ROLE,
ENTERPRISE_OPERATOR_ROLE,
ENTERPRISE_REPORTING_CONFIG_ADMIN_ROLE,
)
from enterprise.models import (
EnterpriseCustomer,
EnterpriseCustomerCatalog,
EnterpriseCustomerUser,
EnterpriseFeatureRole,
EnterpriseFeatureUserRoleAssignment,
SystemWideEnterpriseRole,
SystemWideEnterpriseUserRoleAssignment,
)
try:
from common.djangoapps.student.models import UserProfile
except ImportError:
UserProfile = None
LOGGER = logging.getLogger(__name__)
User = auth.get_user_model()
Group = auth.models.Group
CATALOG_CONTENT_FILTER = {
'content_type': 'courserun',
}
class Command(BaseCommand):
"""
Management command for populating Devstack with initial data for enterprise.
Example usage:
$ ./manage.py lms seed_enterprise_devstack_data
"""
help = '''
Seeds an enterprise customer, users of various roles and permissions initial
data in devstack for related Enterprise models.
'''
def add_arguments(self, parser):
"""
Entry point for subclassed commands to add custom arguments.
"""
parser.add_argument(
'--enterprise-name',
action='store',
dest='enterprise-name',
default='Test Enterprise',
help='Name of enterprise to be created. Defaults to "Test Enterprise".'
)
def _get_default_site(self):
""" Gets or creates the default devstack site example.com """
site = Site.objects.get_or_create(name='example.com')
return site
def _create_enterprise_customer(self, name, site):
""" Gets or creates an EnterpriseCustomer """
enterprise_customer, __ = EnterpriseCustomer.objects.get_or_create(
name=name,
site_id=site.id,
slug=slugify(name),
country='US',
defaults={
'country': 'US',
'enable_learner_portal': True,
'enable_data_sharing_consent': True,
'enable_portal_code_management_screen': True,
'enable_portal_reporting_config_screen': True,
'enable_portal_saml_configuration_screen': True,
'enable_portal_subscription_management_screen': True,
'enable_portal_lms_configurations_screen': True,
},
)
return enterprise_customer
def _create_catalog_for_enterprise(self, enterprise_customer):
""" Gets or creates a catalog for an EnterpriseCustomer """
catalog, __ = EnterpriseCustomerCatalog.objects.get_or_create(
title='All Course Runs',
enterprise_customer=enterprise_customer,
content_filter=CATALOG_CONTENT_FILTER,
)
return catalog
def _create_enterprise_data_api_group(self):
""" Ensures the `ENTERPRISE_DATA_API_ACCESS_GROUP` is created """
Group.objects.get_or_create(name=ENTERPRISE_DATA_API_ACCESS_GROUP)
def _create_enterprise_enrollment_api_group(self):
""" Ensures the `ENTERPRISE_ENROLLMENT_API_ACCESS_GROUP` is created """
Group.objects.get_or_create(name=ENTERPRISE_ENROLLMENT_API_ACCESS_GROUP)
def _create_enterprise_user(self, username, role, enterprise_customer=None, applies_to_all_contexts=False):
"""
Creates a new user with the specified `username` and `role` (e.g.,
'enterprise_learner'). The newly created user is added to the
appropriate Django groups (e.g., data api access) and creates
system-wide and feature role assignments.
"""
valid_roles = [
ENTERPRISE_LEARNER_ROLE,
ENTERPRISE_ADMIN_ROLE,
ENTERPRISE_OPERATOR_ROLE,
]
if role in valid_roles:
is_staff = role == ENTERPRISE_OPERATOR_ROLE
try:
user = User.objects.create_user(
email='{username}@example.com'.format(username=username),
username=username,
password='edx',
is_staff=is_staff,
)
except IntegrityError:
# If a user we attempt to create in this method already exists but with
# slightly different parameters, we will attempt to use the existing user.
user = User.objects.get(username=username)
if user:
self._add_name_to_user_profile(user)
self._add_user_to_groups(user=user, role=role)
self._create_system_wide_role_assignment(
user=user,
role=role,
enterprise_customer=enterprise_customer,
applies_to_all_contexts=applies_to_all_contexts,
)
self._create_feature_role_assignments(user=user, role=role)
return {
"user": user,
"role": role,
}
else:
LOGGER.warning('\nUser not created. Role %s not recognized.', role)
return None
def _add_name_to_user_profile(self, user):
""" Adds a name to a user's profile. """
if not UserProfile:
LOGGER.error('UserProfile module does not exist.')
return
UserProfile.objects.update_or_create(
user=user,
defaults={'name': 'Test Enterprise User'},
)
def _add_user_to_groups(self, user, role):
""" Adds a user with a given role to the appropriate groups """
if role == ENTERPRISE_LEARNER_ROLE:
return
data_api_group = Group.objects.get(name=ENTERPRISE_DATA_API_ACCESS_GROUP)
data_api_group.user_set.add(user)
enrollment_api_group = Group.objects.get(name=ENTERPRISE_ENROLLMENT_API_ACCESS_GROUP)
enrollment_api_group.user_set.add(user)
def _create_system_wide_role_assignment(self, user, role, enterprise_customer, applies_to_all_contexts=False):
"""
Gets or creates a system-wide role assignment for the specified user and role
"""
system_role, __ = SystemWideEnterpriseRole.objects.get_or_create(name=role)
kwargs = {
'user': user,
'role': system_role,
'applies_to_all_contexts': applies_to_all_contexts,
}
if enterprise_customer is not None:
kwargs['enterprise_customer'] = enterprise_customer
# We use filter() here, because the model does not currently enforce uniqueness on (user, role).
if not SystemWideEnterpriseUserRoleAssignment.objects.filter(**kwargs).exists():
SystemWideEnterpriseUserRoleAssignment.objects.create(**kwargs)
def _create_feature_role_assignments(self, user, role):
"""
Gets or creates a feature role assignment for the specified user and role
"""
if role == ENTERPRISE_LEARNER_ROLE:
return
feature_roles = [
ENTERPRISE_CATALOG_ADMIN_ROLE,
ENTERPRISE_DASHBOARD_ADMIN_ROLE,
ENTERPRISE_ENROLLMENT_API_ADMIN_ROLE,
ENTERPRISE_REPORTING_CONFIG_ADMIN_ROLE,
]
for feature_role in feature_roles:
feature_role_obj, __ = EnterpriseFeatureRole.objects.get_or_create(name=feature_role)
EnterpriseFeatureUserRoleAssignment.objects.get_or_create(
user=user,
role=feature_role_obj,
)
def _create_enterprise_customer_user(self, username, enterprise_customer):
"""
Gets or creates an EnterpriseCustomerUser associated with an EnterpriseCustomer
"""
user, __ = User.objects.get_or_create(username=username)
enterprise_customer_user, __ = EnterpriseCustomerUser.objects.update_or_create(
user_id=user.pk,
enterprise_customer=enterprise_customer,
defaults={'active': True},
)
return enterprise_customer_user
def _create_enterprise_linked_data(self, enterprise_users, enterprise_customer):
"""
Creates enterprise data for a given EnterpriseCustomer
including an enterprise catalog and initial users of
varying roles.
"""
enterprise_catalog = self._create_catalog_for_enterprise(
enterprise_customer=enterprise_customer
)
enterprise_linked_users = []
for enterprise_user in enterprise_users:
enterprise_user_obj = self._create_enterprise_customer_user(
username=enterprise_user['user'].username,
enterprise_customer=enterprise_customer,
)
enterprise_linked_users.append({
"enterprise_customer_user": enterprise_user_obj,
"enterprise_role": enterprise_user['role'],
})
return {
"enterprise_customer": enterprise_customer,
"enterprise_catalog": enterprise_catalog,
"enterprise_linked_users": enterprise_linked_users,
}
def handle(self, *args, **options):
"""
Entry point for management command execution.
"""
enterprise_name = options['enterprise-name']
slug = slugify(enterprise_name)
LOGGER.info(
'\nEnsuring enterprise-related Django groups (%s, %s) exist...',
ENTERPRISE_DATA_API_ACCESS_GROUP,
ENTERPRISE_ENROLLMENT_API_ACCESS_GROUP,
)
self._create_enterprise_data_api_group()
self._create_enterprise_enrollment_api_group()
LOGGER.info('\nCreating a new enterprise customer...')
site, __ = self._get_default_site()
enterprise_customer = self._create_enterprise_customer(site=site, name=enterprise_name)
LOGGER.info('\nCreating enterprise users and assigning roles...')
# Create one of each enterprise user type (i.e., learner, admin, operator)
enterprise_users = [
self._create_enterprise_user(
username="{}_{}".format(ENTERPRISE_LEARNER_ROLE, slug),
role=ENTERPRISE_LEARNER_ROLE,
enterprise_customer=enterprise_customer
),
self._create_enterprise_user(
username="{}_{}".format(ENTERPRISE_ADMIN_ROLE, slug),
role=ENTERPRISE_ADMIN_ROLE,
enterprise_customer=enterprise_customer
),
# Creates a super admin who has the admin role on all enterprises.
self._create_enterprise_user(
username=ENTERPRISE_ADMIN_ROLE,
role=ENTERPRISE_ADMIN_ROLE,
applies_to_all_contexts=True,
),
self._create_enterprise_user(
username=ENTERPRISE_OPERATOR_ROLE,
role=ENTERPRISE_OPERATOR_ROLE,
applies_to_all_contexts=True,
),
# Make all of the service workers enterprise_openedx_operators for all enterprises
self._create_enterprise_user(
username='license_manager_worker',
role=ENTERPRISE_OPERATOR_ROLE,
applies_to_all_contexts=True,
),
self._create_enterprise_user(
username='enterprise_catalog_worker',
role=ENTERPRISE_OPERATOR_ROLE,
applies_to_all_contexts=True,
),
self._create_enterprise_user(
username='enterprise_worker',
role=ENTERPRISE_OPERATOR_ROLE,
applies_to_all_contexts=True,
),
self._create_enterprise_user(
username='ecommerce_worker',
role=ENTERPRISE_OPERATOR_ROLE,
applies_to_all_contexts=True,
),
]
# Add a couple more learners!
for i in range(2):
enterprise_users.append(self._create_enterprise_user(
username='{slug}_learner_{index}'.format(
slug=slug,
index=i + 1,
),
role=ENTERPRISE_LEARNER_ROLE,
enterprise_customer=enterprise_customer
))
LOGGER.info('\nCreating enterprise data...')
enterprise = self._create_enterprise_linked_data(
enterprise_users=enterprise_users, enterprise_customer=enterprise_customer)
# generate a json serializable list of linked enterprise users
enterprise_linked_users = []
for item in enterprise['enterprise_linked_users']:
ecu = item['enterprise_customer_user']
enterprise_linked_users.append({
'user_id': ecu.user_id,
'enterprise_customer_user_id': ecu.id,
'username': ecu.username,
})
LOGGER.info(
textwrap.dedent(
'''\nSuccessfully created a new enterprise with the following data:
\n| Enterprise Customer: %s (%s)
\n| Enterprise Catalog: %s (%s)
\n| Enterprise Users (%i): %s
'''
),
enterprise['enterprise_customer'].name,
enterprise['enterprise_customer'].uuid,
enterprise['enterprise_catalog'].title,
enterprise['enterprise_catalog'].uuid,
len(enterprise_linked_users),
json.dumps(enterprise_linked_users, sort_keys=True, indent=2),
)