Skip to content

Commit 45cd3e5

Browse files
pragatimodipragatimodi
committed
changing name from multi_factor_config_mgt to multi_factor_config
1 parent e66bf1d commit 45cd3e5

7 files changed

+66
-66
lines changed

‎firebase_admin/project_config_mgt.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
from firebase_admin import _auth_utils
2323
from firebase_admin import _http_client
2424
from firebase_admin import _utils
25-
from firebase_admin.multi_factor_config_mgt import MultiFactorConfig
26-
from firebase_admin.multi_factor_config_mgt import MultiFactorServerConfig
25+
from firebase_admin.multi_factor_config import MultiFactorConfig
26+
from firebase_admin.multi_factor_config import MultiFactorServerConfig
2727

2828
_PROJECT_CONFIG_MGT_ATTRIBUTE = '_project_config_mgt'
2929

‎firebase_admin/tenant_mgt.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
import firebase_admin
2727
from firebase_admin import auth
28-
from firebase_admin import multi_factor_config_mgt
28+
from firebase_admin import multi_factor_config
2929
from firebase_admin import _auth_utils
3030
from firebase_admin import _http_client
3131
from firebase_admin import _utils
@@ -93,7 +93,7 @@ def get_tenant(tenant_id, app=None):
9393

9494
def create_tenant(
9595
display_name, allow_password_sign_up=None, enable_email_link_sign_in=None,
96-
multi_factor_config: multi_factor_config_mgt.MultiFactorConfig = None, app=None):
96+
multi_factor_config: multi_factor_config.MultiFactorConfig = None, app=None):
9797
"""Creates a new tenant from the given options.
9898
9999
Args:
@@ -122,7 +122,7 @@ def create_tenant(
122122

123123
def update_tenant(
124124
tenant_id, display_name=None, allow_password_sign_up=None, enable_email_link_sign_in=None,
125-
multi_factor_config: multi_factor_config_mgt.MultiFactorConfig = None, app=None):
125+
multi_factor_config: multi_factor_config.MultiFactorConfig = None, app=None):
126126
"""Updates an existing tenant with the given options.
127127
128128
Args:
@@ -238,7 +238,7 @@ def enable_email_link_sign_in(self):
238238
def multi_factor_config(self):
239239
data = self._data.get('mfaConfig', None)
240240
if data is not None:
241-
return multi_factor_config_mgt.MultiFactorServerConfig(data)
241+
return multi_factor_config.MultiFactorServerConfig(data)
242242
return None
243243

244244

@@ -286,7 +286,7 @@ def get_tenant(self, tenant_id):
286286

287287
def create_tenant(
288288
self, display_name, allow_password_sign_up=None, enable_email_link_sign_in=None,
289-
multi_factor_config: multi_factor_config_mgt.MultiFactorConfig = None):
289+
multi_factor_config: multi_factor_config.MultiFactorConfig = None):
290290
"""Creates a new tenant from the given parameters."""
291291

292292
payload = {'displayName': _validate_display_name(display_name)}
@@ -297,7 +297,7 @@ def create_tenant(
297297
payload['enableEmailLinkSignin'] = _auth_utils.validate_boolean(
298298
enable_email_link_sign_in, 'enableEmailLinkSignin')
299299
if multi_factor_config is not None:
300-
if not isinstance(multi_factor_config, multi_factor_config_mgt.MultiFactorConfig):
300+
if not isinstance(multi_factor_config, multi_factor_config.MultiFactorConfig):
301301
raise ValueError(
302302
'multi_factor_config must be of type MultiFactorConfig.')
303303
payload['mfaConfig'] = multi_factor_config.build_server_request()
@@ -311,7 +311,7 @@ def create_tenant(
311311
def update_tenant(
312312
self, tenant_id, display_name=None, allow_password_sign_up=None,
313313
enable_email_link_sign_in=None,
314-
multi_factor_config: multi_factor_config_mgt.MultiFactorConfig = None):
314+
multi_factor_config: multi_factor_config.MultiFactorConfig = None):
315315
"""Updates the specified tenant with the given parameters."""
316316
if not isinstance(tenant_id, str) or not tenant_id:
317317
raise ValueError('Tenant ID must be a non-empty string.')
@@ -326,7 +326,7 @@ def update_tenant(
326326
payload['enableEmailLinkSignin'] = _auth_utils.validate_boolean(
327327
enable_email_link_sign_in, 'enableEmailLinkSignin')
328328
if multi_factor_config is not None:
329-
if not isinstance(multi_factor_config, multi_factor_config_mgt.MultiFactorConfig):
329+
if not isinstance(multi_factor_config, multi_factor_config.MultiFactorConfig):
330330
raise ValueError('multi_factor_config must be of type MultiFactorConfig.')
331331
payload['mfaConfig'] = multi_factor_config.build_server_request()
332332

‎integration/test_project_config_mgt.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import pytest
1818

1919
from firebase_admin import project_config_mgt
20-
from firebase_admin import multi_factor_config_mgt
20+
from firebase_admin import multi_factor_config
2121

2222

2323
@pytest.fixture(scope='module')
@@ -36,11 +36,11 @@ def sample_mfa_config():
3636

3737

3838
def test_update_project_config():
39-
mfa_object = multi_factor_config_mgt.MultiFactorConfig(
39+
mfa_object = multi_factor_config.MultiFactorConfig(
4040
provider_configs=[
41-
multi_factor_config_mgt.ProviderConfig(
42-
state=multi_factor_config_mgt.ProviderConfig.State.ENABLED,
43-
totp_provider_config=multi_factor_config_mgt.TOTPProviderConfig(
41+
multi_factor_config.ProviderConfig(
42+
state=multi_factor_config.ProviderConfig.State.ENABLED,
43+
totp_provider_config=multi_factor_config.TOTPProviderConfig(
4444
adjacent_intervals=5
4545
)
4646
)
@@ -56,14 +56,14 @@ def test_get_project():
5656
_assert_multi_factor_config(project_config.multi_factor_config)
5757

5858
def _assert_multi_factor_config(multi_factor_config):
59-
assert isinstance(multi_factor_config, multi_factor_config_mgt.MultiFactorServerConfig)
59+
assert isinstance(multi_factor_config, multi_factor_config.MultiFactorServerConfig)
6060
assert len(multi_factor_config.provider_configs) == 1
6161
assert isinstance(multi_factor_config.provider_configs, list)
6262
for provider_config in multi_factor_config.provider_configs:
63-
assert isinstance(provider_config, multi_factor_config_mgt.MultiFactorServerConfig
63+
assert isinstance(provider_config, multi_factor_config.MultiFactorServerConfig
6464
.ProviderConfigServerConfig)
6565
assert provider_config.state == 'ENABLED'
6666
assert isinstance(provider_config.totp_provider_config,
67-
multi_factor_config_mgt.MultiFactorServerConfig.ProviderConfigServerConfig
67+
multi_factor_config.MultiFactorServerConfig.ProviderConfigServerConfig
6868
.TOTPProviderServerConfig)
6969
assert provider_config.totp_provider_config.adjacent_intervals == 5

‎integration/test_tenant_mgt.py

+12-12
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
from firebase_admin import auth
2727
from firebase_admin import tenant_mgt
28-
from firebase_admin import multi_factor_config_mgt
28+
from firebase_admin import multi_factor_config
2929
from integration import test_auth
3030

3131

@@ -36,10 +36,10 @@
3636

3737
@pytest.fixture(scope='module')
3838
def sample_tenant():
39-
mfa_object = multi_factor_config_mgt.MultiFactorConfig(
40-
provider_configs=[multi_factor_config_mgt.ProviderConfig(
41-
state=multi_factor_config_mgt.ProviderConfig.State.ENABLED,
42-
totp_provider_config=multi_factor_config_mgt.TOTPProviderConfig(
39+
mfa_object = multi_factor_config.MultiFactorConfig(
40+
provider_configs=[multi_factor_config.ProviderConfig(
41+
state=multi_factor_config.ProviderConfig.State.ENABLED,
42+
totp_provider_config=multi_factor_config.TOTPProviderConfig(
4343
adjacent_intervals=5
4444
)
4545
)]
@@ -53,15 +53,15 @@ def sample_tenant():
5353
tenant_mgt.delete_tenant(tenant.tenant_id)
5454

5555
def _assert_multi_factor_config(mfa_config):
56-
assert isinstance(mfa_config, multi_factor_config_mgt.MultiFactorServerConfig)
56+
assert isinstance(mfa_config, multi_factor_config.MultiFactorServerConfig)
5757
assert len(mfa_config.provider_configs) == 1
5858
assert isinstance(mfa_config.provider_configs, list)
5959
for provider_config in mfa_config.provider_configs:
60-
assert isinstance(provider_config, multi_factor_config_mgt.MultiFactorServerConfig.\
60+
assert isinstance(provider_config, multi_factor_config.MultiFactorServerConfig.\
6161
ProviderConfigServerConfig)
6262
assert provider_config.state == 'ENABLED'
6363
assert isinstance(provider_config.totp_provider_config,
64-
multi_factor_config_mgt.MultiFactorServerConfig.ProviderConfigServerConfig
64+
multi_factor_config.MultiFactorServerConfig.ProviderConfigServerConfig
6565
.TOTPProviderServerConfig)
6666
assert provider_config.totp_provider_config.adjacent_intervals == 5
6767

@@ -99,10 +99,10 @@ def test_list_tenants(sample_tenant):
9999

100100

101101
def test_update_tenant():
102-
mfa_object = multi_factor_config_mgt.MultiFactorConfig(
103-
provider_configs=[multi_factor_config_mgt.ProviderConfig(
104-
state=multi_factor_config_mgt.ProviderConfig.State.ENABLED,
105-
totp_provider_config=multi_factor_config_mgt.TOTPProviderConfig(
102+
mfa_object = multi_factor_config.MultiFactorConfig(
103+
provider_configs=[multi_factor_config.ProviderConfig(
104+
state=multi_factor_config.ProviderConfig.State.ENABLED,
105+
totp_provider_config=multi_factor_config.TOTPProviderConfig(
106106
adjacent_intervals=5
107107
)
108108
)]

‎tests/test_multi_factor_config.py

+16-16
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515

1616
import pytest
1717

18-
from firebase_admin import multi_factor_config_mgt
18+
from firebase_admin import multi_factor_config
1919

20-
sample_mfa_config = multi_factor_config_mgt.MultiFactorConfig(
21-
provider_configs=[multi_factor_config_mgt.ProviderConfig(
22-
state=multi_factor_config_mgt.ProviderConfig.State.ENABLED,
23-
totp_provider_config=multi_factor_config_mgt.TOTPProviderConfig(
20+
sample_mfa_config = multi_factor_config.MultiFactorConfig(
21+
provider_configs=[multi_factor_config.ProviderConfig(
22+
state=multi_factor_config.ProviderConfig.State.ENABLED,
23+
totp_provider_config=multi_factor_config.TOTPProviderConfig(
2424
adjacent_intervals=5
2525
)
2626
)]
@@ -78,7 +78,7 @@ def test_undefined_provider_config_state(self):
7878
@pytest.mark.parametrize('state',
7979
['', 1, True, False, [], (), {}, "foo", 'ENABLED'])
8080
def test_invalid_provider_config_state(self, state):
81-
test_config = multi_factor_config_mgt.ProviderConfig(
81+
test_config = multi_factor_config.ProviderConfig(
8282
state=state
8383
)
8484
with pytest.raises(ValueError) as excinfo:
@@ -87,10 +87,10 @@ def test_invalid_provider_config_state(self, state):
8787
' ProviderConfig.State.')
8888

8989
@pytest.mark.parametrize('state',
90-
[multi_factor_config_mgt.ProviderConfig.State.ENABLED,
91-
multi_factor_config_mgt.ProviderConfig.State.DISABLED])
90+
[multi_factor_config.ProviderConfig.State.ENABLED,
91+
multi_factor_config.ProviderConfig.State.DISABLED])
9292
def test_undefined_totp_provider_config(self, state):
93-
test_config = multi_factor_config_mgt.ProviderConfig(state=state)
93+
test_config = multi_factor_config.ProviderConfig(state=state)
9494
with pytest.raises(ValueError) as excinfo:
9595
test_config.build_server_request()
9696
assert str(excinfo.value).startswith('provider_config.totp_provider_config must be'
@@ -134,21 +134,21 @@ class TestMultiFactorServerConfig:
134134
def test_invalid_multi_factor_config_response(self):
135135
test_config = 'invalid'
136136
with pytest.raises(ValueError) as excinfo:
137-
multi_factor_config_mgt.MultiFactorServerConfig(test_config)
137+
multi_factor_config.MultiFactorServerConfig(test_config)
138138
assert str(excinfo.value).startswith('Invalid data argument in MultiFactorConfig'
139139
' constructor: {0}'.format(test_config))
140140

141141
def test_invalid_provider_config_response(self):
142142
test_config = 'invalid'
143143
with pytest.raises(ValueError) as excinfo:
144-
multi_factor_config_mgt.MultiFactorServerConfig.ProviderConfigServerConfig(test_config)
144+
multi_factor_config.MultiFactorServerConfig.ProviderConfigServerConfig(test_config)
145145
assert str(excinfo.value).startswith('Invalid data argument in ProviderConfig'
146146
' constructor: {0}'.format(test_config))
147147

148148
def test_invalid_totp_provider_config_response(self):
149149
test_config = 'invalid'
150150
with pytest.raises(ValueError) as excinfo:
151-
multi_factor_config_mgt.MultiFactorServerConfig.ProviderConfigServerConfig.\
151+
multi_factor_config.MultiFactorServerConfig.ProviderConfigServerConfig.\
152152
TOTPProviderServerConfig(test_config)
153153
assert str(excinfo.value).startswith('Invalid data argument in TOTPProviderConfig'
154154
' constructor: {0}'.format(test_config))
@@ -162,20 +162,20 @@ def test_valid_server_response(self):
162162
}
163163
}]
164164
}
165-
mfa_config = multi_factor_config_mgt.MultiFactorServerConfig(response)
165+
mfa_config = multi_factor_config.MultiFactorServerConfig(response)
166166
_assert_multi_factor_config(mfa_config)
167167

168168

169169
def _assert_multi_factor_config(mfa_config):
170-
assert isinstance(mfa_config, multi_factor_config_mgt.MultiFactorServerConfig)
170+
assert isinstance(mfa_config, multi_factor_config.MultiFactorServerConfig)
171171
assert len(mfa_config.provider_configs) == 1
172172
assert isinstance(mfa_config.provider_configs, list)
173173
for provider_config in mfa_config.provider_configs:
174174
assert isinstance(
175175
provider_config,
176-
multi_factor_config_mgt.MultiFactorServerConfig.ProviderConfigServerConfig)
176+
multi_factor_config.MultiFactorServerConfig.ProviderConfigServerConfig)
177177
assert provider_config.state == 'ENABLED'
178178
assert isinstance(provider_config.totp_provider_config,
179-
multi_factor_config_mgt.MultiFactorServerConfig.ProviderConfigServerConfig
179+
multi_factor_config.MultiFactorServerConfig.ProviderConfigServerConfig
180180
.TOTPProviderServerConfig)
181181
assert provider_config.totp_provider_config.adjacent_intervals == 5

‎tests/test_project_config_mgt.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
import firebase_admin
2424
from firebase_admin import project_config_mgt
25-
from firebase_admin import multi_factor_config_mgt
25+
from firebase_admin import multi_factor_config
2626

2727

2828
GET_PROJECT_RESPONSE = """{
@@ -124,11 +124,11 @@ def test_invalid_multi_factor_config_type(self, multi_factor_config, project_con
124124
def test_update_project_config(self, project_config_mgt_app):
125125
_, recorder = _instrument_project_config_mgt(
126126
project_config_mgt_app, 200, GET_PROJECT_RESPONSE)
127-
mfa_object = multi_factor_config_mgt.MultiFactorConfig(
127+
mfa_object = multi_factor_config.MultiFactorConfig(
128128
provider_configs=[
129-
multi_factor_config_mgt.ProviderConfig(
130-
state=multi_factor_config_mgt.ProviderConfig.State.ENABLED,
131-
totp_provider_config=multi_factor_config_mgt.TOTPProviderConfig(
129+
multi_factor_config.ProviderConfig(
130+
state=multi_factor_config.ProviderConfig.State.ENABLED,
131+
totp_provider_config=multi_factor_config.TOTPProviderConfig(
132132
adjacent_intervals=5
133133
)
134134
)
@@ -163,15 +163,15 @@ def _assert_request(self, recorder, body, mask):
163163
assert got == body
164164

165165
def _assert_multi_factor_config(multi_factor_config):
166-
assert isinstance(multi_factor_config, multi_factor_config_mgt.MultiFactorServerConfig)
166+
assert isinstance(multi_factor_config, multi_factor_config.MultiFactorServerConfig)
167167
assert len(multi_factor_config.provider_configs) == 1
168168
assert isinstance(multi_factor_config.provider_configs, list)
169169
for provider_config in multi_factor_config.provider_configs:
170-
assert isinstance(provider_config, multi_factor_config_mgt.MultiFactorServerConfig
170+
assert isinstance(provider_config, multi_factor_config.MultiFactorServerConfig
171171
.ProviderConfigServerConfig)
172172
assert provider_config.state == 'ENABLED'
173173
assert isinstance(provider_config.totp_provider_config,
174-
multi_factor_config_mgt.MultiFactorServerConfig.ProviderConfigServerConfig
174+
multi_factor_config.MultiFactorServerConfig.ProviderConfigServerConfig
175175
.TOTPProviderServerConfig)
176176
assert provider_config.totp_provider_config.adjacent_intervals == 5
177177

‎tests/test_tenant_mgt.py

+12-12
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
from firebase_admin import tenant_mgt
2727
from firebase_admin import _auth_providers
2828
from firebase_admin import _user_mgt
29-
from firebase_admin import multi_factor_config_mgt
29+
from firebase_admin import multi_factor_config
3030
from tests import testutils
3131
from tests import test_token_gen
3232

@@ -255,11 +255,11 @@ def test_invalid_multi_factor_configs(self, multi_factor_config, tenant_mgt_app)
255255

256256
def test_create_tenant(self, tenant_mgt_app):
257257
_, recorder = _instrument_tenant_mgt(tenant_mgt_app, 200, GET_TENANT_RESPONSE)
258-
mfa_object = multi_factor_config_mgt.MultiFactorConfig(
258+
mfa_object = multi_factor_config.MultiFactorConfig(
259259
provider_configs=[
260-
multi_factor_config_mgt.ProviderConfig(
261-
state=multi_factor_config_mgt.ProviderConfig.State.ENABLED,
262-
totp_provider_config=multi_factor_config_mgt.TOTPProviderConfig(
260+
multi_factor_config.ProviderConfig(
261+
state=multi_factor_config.ProviderConfig.State.ENABLED,
262+
totp_provider_config=multi_factor_config.TOTPProviderConfig(
263263
adjacent_intervals=5
264264
)
265265
)
@@ -374,11 +374,11 @@ def test_update_tenant_no_args(self, tenant_mgt_app):
374374

375375
def test_update_tenant(self, tenant_mgt_app):
376376
_, recorder = _instrument_tenant_mgt(tenant_mgt_app, 200, GET_TENANT_RESPONSE)
377-
mfa_object = multi_factor_config_mgt.MultiFactorConfig(
377+
mfa_object = multi_factor_config.MultiFactorConfig(
378378
provider_configs=[
379-
multi_factor_config_mgt.ProviderConfig(
380-
state=multi_factor_config_mgt.ProviderConfig.State.ENABLED,
381-
totp_provider_config=multi_factor_config_mgt.TOTPProviderConfig(
379+
multi_factor_config.ProviderConfig(
380+
state=multi_factor_config.ProviderConfig.State.ENABLED,
381+
totp_provider_config=multi_factor_config.TOTPProviderConfig(
382382
adjacent_intervals=5
383383
)
384384
)
@@ -1063,15 +1063,15 @@ def test_custom_token_with_claims(self, tenant_aware_custom_token_app):
10631063
custom_token, expected_claims=claims, tenant_id='test-tenant')
10641064

10651065
def _assert_multi_factor_config(mfa_config):
1066-
assert isinstance(mfa_config, multi_factor_config_mgt.MultiFactorServerConfig)
1066+
assert isinstance(mfa_config, multi_factor_config.MultiFactorServerConfig)
10671067
assert len(mfa_config.provider_configs) == 1
10681068
assert isinstance(mfa_config.provider_configs, list)
10691069
for provider_config in mfa_config.provider_configs:
1070-
assert isinstance(provider_config, multi_factor_config_mgt.MultiFactorServerConfig.\
1070+
assert isinstance(provider_config, multi_factor_config.MultiFactorServerConfig.\
10711071
ProviderConfigServerConfig)
10721072
assert provider_config.state == 'ENABLED'
10731073
assert isinstance(provider_config.totp_provider_config,
1074-
multi_factor_config_mgt.MultiFactorServerConfig.ProviderConfigServerConfig
1074+
multi_factor_config.MultiFactorServerConfig.ProviderConfigServerConfig
10751075
.TOTPProviderServerConfig)
10761076
assert provider_config.totp_provider_config.adjacent_intervals == 5
10771077

0 commit comments

Comments
 (0)