Browse Source

fix: changed keycloak admin unittests so they accomodate with new keycloak release 26

pull/601/head
Alex Rohozneanu 7 months ago
parent
commit
1036de9427
  1. 2
      .github/workflows/lint.yaml
  2. 161
      tests/test_keycloak_admin.py

2
.github/workflows/lint.yaml

@ -56,7 +56,7 @@ jobs:
fail-fast: false
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
keycloak-version: ["21.0", "22.0", "23.0", "24.0", "25.0", "latest"]
keycloak-version: ["21.0", "22.0", "23.0", "24.0", "25.0", "26.0", "latest"]
needs:
- check-commits
- check-linting

161
tests/test_keycloak_admin.py

@ -1745,9 +1745,15 @@ def test_client_optional_client_scopes(admin: KeycloakAdmin, realm: str, client:
payload={"name": "role-testing-client", "clientId": "role-testing-client"}
)
# Test get client optional scopes
# keycloak optional roles: microprofile-jwt, offline_access, address, phone
# keycloak optional roles: microprofile-jwt, offline_access, address, --> for versions < 26.0.0
# starting with Keycloak version 26.0.0 a new optional role is added: organization
optional_client_scopes = admin.get_client_optional_client_scopes(client_id)
assert len(optional_client_scopes) == 4, optional_client_scopes
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(optional_client_scopes) == 5, optional_client_scopes
else:
assert len(optional_client_scopes) == 4, optional_client_scopes
# Test add a client scope to client optional scopes
optional_client_scope = "test-client-optional-scope"
@ -1767,12 +1773,22 @@ def test_client_optional_client_scopes(admin: KeycloakAdmin, realm: str, client:
client_id, new_client_scope_id, new_optional_client_scope_data
)
optional_client_scopes = admin.get_client_optional_client_scopes(client_id)
assert len(optional_client_scopes) == 5, optional_client_scopes
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(optional_client_scopes) == 6, optional_client_scopes
else:
assert len(optional_client_scopes) == 5, optional_client_scopes
# Test remove a client optional scope
admin.delete_client_optional_client_scope(client_id, new_client_scope_id)
optional_client_scopes = admin.get_client_optional_client_scopes(client_id)
assert len(optional_client_scopes) == 4, optional_client_scopes
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(optional_client_scopes) == 5, optional_client_scopes
else:
assert len(optional_client_scopes) == 4, optional_client_scopes
def test_client_roles(admin: KeycloakAdmin, client: str):
@ -2242,7 +2258,12 @@ def test_auth_flows(admin: KeycloakAdmin, realm: str):
# Test flow executions
res = admin.get_authentication_flow_executions(flow_alias="browser")
assert len(res) == 8, res
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(res) == 12, res
else:
assert len(res) == 8, res
with pytest.raises(KeycloakGetError) as err:
admin.get_authentication_flow_executions(flow_alias="bad")
assert ('b\'{"error":"Flow not found"' in str(err)) or err.match("404: b''")
@ -2405,7 +2426,12 @@ def test_client_scopes(admin: KeycloakAdmin, realm: str):
# Test get client scopes
res = admin.get_client_scopes()
scope_names = {x["name"] for x in res}
assert len(res) in [10, 11]
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(res) == 13
else:
assert len(res) in [10, 11]
assert "email" in scope_names
assert "profile" in scope_names
assert "offline_access" in scope_names
@ -2496,7 +2522,12 @@ def test_client_scopes(admin: KeycloakAdmin, realm: str):
# Test default default scopes
res_defaults = admin.get_default_default_client_scopes()
assert len(res_defaults) in [6, 7]
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(res_defaults) == 8
else:
assert len(res_defaults) in [6, 7]
with pytest.raises(KeycloakPutError) as err:
admin.add_default_default_client_scope(scope_id="does-not-exist")
@ -2504,7 +2535,12 @@ def test_client_scopes(admin: KeycloakAdmin, realm: str):
res_add = admin.add_default_default_client_scope(scope_id=res)
assert res_add == dict()
assert len(admin.get_default_default_client_scopes()) in [7, 8]
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(admin.get_default_default_client_scopes()) == 9
else:
assert len(admin.get_default_default_client_scopes()) in [7, 8]
with pytest.raises(KeycloakDeleteError) as err:
admin.delete_default_default_client_scope(scope_id="does-not-exist")
@ -2512,11 +2548,21 @@ def test_client_scopes(admin: KeycloakAdmin, realm: str):
res_del = admin.delete_default_default_client_scope(scope_id=res)
assert res_del == dict()
assert len(admin.get_default_default_client_scopes()) in [6, 7]
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(admin.get_default_default_client_scopes()) == 8
else:
assert len(admin.get_default_default_client_scopes()) in [6, 7]
# Test default optional scopes
res_defaults = admin.get_default_optional_client_scopes()
assert len(res_defaults) == 4
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(res_defaults) == 5
else:
assert len(res_defaults) == 4
with pytest.raises(KeycloakPutError) as err:
admin.add_default_optional_client_scope(scope_id="does-not-exist")
@ -2524,7 +2570,12 @@ def test_client_scopes(admin: KeycloakAdmin, realm: str):
res_add = admin.add_default_optional_client_scope(scope_id=res)
assert res_add == dict()
assert len(admin.get_default_optional_client_scopes()) == 5
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(admin.get_default_optional_client_scopes()) == 6
else:
assert len(admin.get_default_optional_client_scopes()) == 5
with pytest.raises(KeycloakDeleteError) as err:
admin.delete_default_optional_client_scope(scope_id="does-not-exist")
@ -2532,7 +2583,12 @@ def test_client_scopes(admin: KeycloakAdmin, realm: str):
res_del = admin.delete_default_optional_client_scope(scope_id=res)
assert res_del == dict()
assert len(admin.get_default_optional_client_scopes()) == 4
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(admin.get_default_optional_client_scopes()) == 5
else:
assert len(admin.get_default_optional_client_scopes()) == 4
# Test client scope delete
res_del = admin.delete_client_scope(client_scope_id=res)
@ -4791,10 +4847,15 @@ async def test_a_client_optional_client_scopes(admin: KeycloakAdmin, realm: str,
payload={"name": "role-testing-client", "clientId": "role-testing-client"}
)
# Test get client optional scopes
# keycloak optional roles: microprofile-jwt, offline_access, address, phone
# keycloak optional roles: microprofile-jwt, offline_access, address, --> for versions < 26.0.0
# starting with Keycloak version 26.0.0 a new optional role is added: organization
optional_client_scopes = await admin.a_get_client_optional_client_scopes(client_id)
assert len(optional_client_scopes) == 4, optional_client_scopes
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(optional_client_scopes) == 5, optional_client_scopes
else:
assert len(optional_client_scopes) == 4, optional_client_scopes
# Test add a client scope to client optional scopes
optional_client_scope = "test-client-optional-scope"
new_client_scope = {
@ -4813,12 +4874,22 @@ async def test_a_client_optional_client_scopes(admin: KeycloakAdmin, realm: str,
client_id, new_client_scope_id, new_optional_client_scope_data
)
optional_client_scopes = await admin.a_get_client_optional_client_scopes(client_id)
assert len(optional_client_scopes) == 5, optional_client_scopes
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(optional_client_scopes) == 6, optional_client_scopes
else:
assert len(optional_client_scopes) == 5, optional_client_scopes
# Test remove a client optional scope
await admin.a_delete_client_optional_client_scope(client_id, new_client_scope_id)
optional_client_scopes = await admin.a_get_client_optional_client_scopes(client_id)
assert len(optional_client_scopes) == 4, optional_client_scopes
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(optional_client_scopes) == 5, optional_client_scopes
else:
assert len(optional_client_scopes) == 4, optional_client_scopes
@pytest.mark.asyncio
@ -5375,7 +5446,12 @@ async def test_a_auth_flows(admin: KeycloakAdmin, realm: str):
# Test flow executions
res = await admin.a_get_authentication_flow_executions(flow_alias="browser")
assert len(res) == 8, res
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(res) == 12, res
else:
assert len(res) == 8, res
with pytest.raises(KeycloakGetError) as err:
await admin.a_get_authentication_flow_executions(flow_alias="bad")
assert ('b\'{"error":"Flow not found"' in str(err)) or err.match("404: b''")
@ -5543,7 +5619,12 @@ async def test_a_client_scopes(admin: KeycloakAdmin, realm: str):
# Test get client scopes
res = await admin.a_get_client_scopes()
scope_names = {x["name"] for x in res}
assert len(res) in [10, 11]
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(res) == 13
else:
assert len(res) in [10, 11]
assert "email" in scope_names
assert "profile" in scope_names
assert "offline_access" in scope_names
@ -5633,7 +5714,12 @@ async def test_a_client_scopes(admin: KeycloakAdmin, realm: str):
# Test default default scopes
res_defaults = await admin.a_get_default_default_client_scopes()
assert len(res_defaults) in [6, 7]
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(res_defaults) == 8
else:
assert len(res_defaults) in [6, 7]
with pytest.raises(KeycloakPutError) as err:
await admin.a_add_default_default_client_scope(scope_id="does-not-exist")
@ -5641,7 +5727,12 @@ async def test_a_client_scopes(admin: KeycloakAdmin, realm: str):
res_add = await admin.a_add_default_default_client_scope(scope_id=res)
assert res_add == dict()
assert len(admin.get_default_default_client_scopes()) in [7, 8]
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(admin.get_default_default_client_scopes()) == 9
else:
assert len(admin.get_default_default_client_scopes()) in [7, 8]
with pytest.raises(KeycloakDeleteError) as err:
await admin.a_delete_default_default_client_scope(scope_id="does-not-exist")
@ -5649,11 +5740,21 @@ async def test_a_client_scopes(admin: KeycloakAdmin, realm: str):
res_del = await admin.a_delete_default_default_client_scope(scope_id=res)
assert res_del == dict()
assert len(admin.get_default_default_client_scopes()) in [6, 7]
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(admin.get_default_default_client_scopes()) == 8
else:
assert len(admin.get_default_default_client_scopes()) in [6, 7]
# Test default optional scopes
res_defaults = await admin.a_get_default_optional_client_scopes()
assert len(res_defaults) == 4
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(res_defaults) == 5
else:
assert len(res_defaults) == 4
with pytest.raises(KeycloakPutError) as err:
await admin.a_add_default_optional_client_scope(scope_id="does-not-exist")
@ -5661,7 +5762,12 @@ async def test_a_client_scopes(admin: KeycloakAdmin, realm: str):
res_add = await admin.a_add_default_optional_client_scope(scope_id=res)
assert res_add == dict()
assert len(await admin.a_get_default_optional_client_scopes()) == 5
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(await admin.a_get_default_optional_client_scopes()) == 6
else:
assert len(await admin.a_get_default_optional_client_scopes()) == 5
with pytest.raises(KeycloakDeleteError) as err:
await admin.a_delete_default_optional_client_scope(scope_id="does-not-exist")
@ -5669,7 +5775,12 @@ async def test_a_client_scopes(admin: KeycloakAdmin, realm: str):
res_del = await admin.a_delete_default_optional_client_scope(scope_id=res)
assert res_del == dict()
assert len(await admin.a_get_default_optional_client_scopes()) == 4
if os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"] == "latest" or Version(
os.environ["KEYCLOAK_DOCKER_IMAGE_TAG"]
) >= Version("26"):
assert len(await admin.a_get_default_optional_client_scopes()) == 5
else:
assert len(await admin.a_get_default_optional_client_scopes()) == 4
# Test client scope delete
res_del = await admin.a_delete_client_scope(client_scope_id=res)

Loading…
Cancel
Save