Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Add restrictions docs #832

Merged
merged 10 commits into from
Sep 13, 2024
Merged

📝 Add restrictions docs #832

merged 10 commits into from
Sep 13, 2024

Conversation

cl0ete
Copy link
Collaborator

@cl0ete cl0ete commented Jun 6, 2024

Add docs on restrictions

@cl0ete cl0ete added the documentation Improvements or additions to documentation label Jun 6, 2024
@cl0ete cl0ete self-assigned this Jun 6, 2024
Copy link

sonarcloud bot commented Jun 11, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@cl0ete cl0ete changed the title WIP: Add restrictions docs Add restrictions docs Jun 11, 2024
@cl0ete cl0ete marked this pull request as ready for review June 11, 2024 08:53
@cl0ete cl0ete requested a review from ff137 June 11, 2024 08:54
@cl0ete cl0ete marked this pull request as draft June 18, 2024 13:27
@ff137 ff137 changed the title Add restrictions docs 📝 Add restrictions docs Jul 24, 2024
Copy link

sonarcloud bot commented Aug 1, 2024

Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app/routes
   issuer.py185299%682–683
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1483378%100–102, 107, 167–169, 174, 250, 258–260, 265, 309–314, 320–322, 395–397, 403, 442–444, 449, 485–487, 543–545
   webhooks.py16475%32–36, 57–61
   websocket_endpoint.py23865%24–25, 37–42, 54–57, 70–76
app/routes/wallet
   credentials.py775232%32–45, 54–66, 75–86, 95–109, 120–136, 148–162, 171–183, 192–203
   jws.py422736%35–60, 76–99
   sd_jws.py422736%36–61, 78–101
app/services
   acapy_ledger.py611280%110–111, 124–140, 196–197
   acapy_wallet.py40490%60–61, 98–99
   revocation_registry.py1723580%118–160, 201–205, 372–376, 415–420, 453–457, 485–490, 539–540
   webhooks.py271833%17–25, 29–39
   websocket.py514120%19–22, 29–36, 47–91
app/services/event_handling
   websocket_manager.py732664%64–68, 87–90, 97–108, 115–125, 139
app/services/issuer
   acapy_issuer_v1.py871484%36, 76–110, 205–206
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
   tenants.py594524%30–98, 108–138
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py86397%100–102
   set_endorser_metadata.py724044%28–30, 50–52, 76–78, 109–128, 140–151, 163–176, 189–203
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/tests/e2e
   conftest.py23578%46–54
   test_connections.py149299%281–282
   test_jsonld.py591673%134–169
   test_proof_request_models.py31197%130
   test_tenants.py4201596%203, 247–248, 287, 788, 832–833, 842–843, 852–853, 865–866, 875–876
   test_wallet_credentials.py30197%55
   test_wallet_dids.py701086%101–116
app/tests/e2e/issuer
   test_get_records_paginated.py63297%66–67
   test_save_exchange_record.py74199%180
app/tests/e2e/verifier
   test_get_records_paginated.py62297%60–61
   test_proof_revoked_credential.py451273%130–203
   test_verifier.py2361295%691–762
app/tests/exception_handling
   test_handle_model_with_validation.py23196%22
app/tests/fixtures
   credentials.py1193769%176, 270–351, 364–436
   definitions.py662661%29–50, 64–65, 94–124, 143–144
   member_acapy_clients.py36489%47–50, 73–74
   member_connections.py43881%80–91, 130–141
   member_wallets.py611575%29–34, 49–54, 69–74, 89–94, 111–118
app/tests/routes/issuer
   test_create_offer.py39197%150
   test_send_credential.py36197%129
app/tests/routes/wallet/dids
   test_get_public_did.py29197%40
app/tests/services
   test_revocation_registry.py149299%75, 106
app/tests/services/issuer
   test_issuer.py160299%359–363
app/tests/util
   connections.py872967%104–129, 138–155, 172–181, 236–256
   ledger.py501080%35, 43, 55, 63–67, 77, 83
   regression_testing.py351751%33, 41–68, 74–81
   sse_listener.py41880%50–55, 79–84
   trust_registry.py29390%24, 27–28
   webhooks.py56591%20, 79–82, 105, 129
app/util
   acapy_issuer_utils.py18194%22
   acapy_verifier_utils.py137596%108–111, 191–195, 272
   assert_public_did.py18856%17–33
   credentials.py13285%11, 18
   retry_method.py361558%20–35, 76–77, 91–103
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14286%31–32
endorser/services
   endorsement_processor.py137696%90, 152–162
webhooks/models
   conversions.py63690%70, 83, 91, 112, 149, 168
webhooks/services
   acapy_events_processor.py1933283%98, 161–171, 194–208, 222, 229–235, 261, 289–290, 318–322, 335–339, 364–377
   billing_manager.py175498%91, 98–99, 132
   sse_manager.py2343685%155, 157–170, 208–218, 251–252, 265–279, 334–338, 344–347, 349–352, 377–378, 421–423, 457, 468–469
   webhooks_redis_service.py1401986%70, 237–238, 354, 378–398, 411–422
webhooks/tests/services
   test_acapy_events_processor.py161299%168–171
   test_sse_manager.py179398%214–215, 221
webhooks/web/routers
   sse.py102397%168–171
TOTAL1511692894% 

Tests Skipped Failures Errors Time
1083 4 💤 0 ❌ 0 🔥 5m 44s ⏱️

Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app/routes
   issuer.py185299%682–683
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1483378%100–102, 107, 167–169, 174, 250, 258–260, 265, 309–314, 320–322, 395–397, 403, 442–444, 449, 485–487, 543–545
   webhooks.py16475%32–36, 57–61
   websocket_endpoint.py23865%24–25, 37–42, 54–57, 70–76
app/routes/wallet
   credentials.py775232%32–45, 54–66, 75–86, 95–109, 120–136, 148–162, 171–183, 192–203
   jws.py422736%35–60, 76–99
   sd_jws.py422736%36–61, 78–101
app/services
   acapy_ledger.py611969%43–49, 79, 110–111, 124–140, 146–149, 196–197
   acapy_wallet.py401270%49–64, 98–99
   revocation_registry.py1724673%118–160, 201–205, 372–376, 415–420, 453–457, 475–490, 496–505, 539–540
   webhooks.py271833%17–25, 29–39
   websocket.py514120%19–22, 29–36, 47–91
app/services/event_handling
   websocket_manager.py732664%64–68, 87–90, 97–108, 115–125, 139
app/services/issuer
   acapy_issuer_v1.py871484%36, 76–110, 205–206
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
   tenants.py594524%30–98, 108–138
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py86397%100–102
   set_endorser_metadata.py724044%28–30, 50–52, 76–78, 109–128, 140–151, 163–176, 189–203
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/tests/e2e
   conftest.py23578%46–54
   test_connections.py149299%281–282
   test_definitions.py795135%33–56, 68–80, 92–106, 118–146, 164–209
   test_jsonld.py591673%134–169
   test_proof_request_models.py31197%130
   test_revocation.py1117334%27–77, 90–107, 118–144, 156–181, 193–207, 219–256, 267–293, 305–335, 346–349
   test_tenants.py42036314%29–73, 84–117, 128–172, 185–254, 265–316, 329–458, 467–519, 528–564, 573–622, 631–680, 691–733, 745–794, 805–876, 885–992
   test_wallet_dids.py701579%101–116, 128–139
app/tests/e2e/issuer
   test_get_records_paginated.py635217%25–162
   test_save_exchange_record.py74199%180
app/tests/e2e/verifier
   test_get_credentials_by_proof_id.py251252%27–82
   test_get_records_paginated.py624921%27–156
   test_proof_revoked_credential.py451176%39–116
app/tests/exception_handling
   test_handle_model_with_validation.py23196%22
app/tests/fixtures
   credentials.py1195554%132–207, 216–224, 234–255, 289–349, 384–434
   definitions.py661085%41–48, 57–63, 114–121, 134–139
   member_acapy_clients.py36489%47–50, 73–74
   member_async_clients.py50296%32–33
   member_connections.py43491%73, 91, 123, 141
   member_wallets.py611575%23–27, 43–47, 63–67, 83–87, 103–109
app/tests/routes/issuer
   test_create_offer.py39197%150
   test_send_credential.py36197%129
app/tests/routes/wallet/dids
   test_get_public_did.py29197%40
app/tests/services
   test_revocation_registry.py149299%75, 106
app/tests/services/issuer
   test_issuer.py160299%359–363
app/tests/util
   connections.py871978%154–155, 169, 181, 191–223, 251–256
   ledger.py502648%34–59, 63–67, 73–86
   regression_testing.py35974%33, 60–68, 74–81
   sse_listener.py41880%50–55, 79–84
   tenants.py241250%10, 16–17, 21–26, 30–35, 39–44, 48–53, 57
   trust_registry.py29776%20–28
   webhooks.py56591%20, 79–82, 105, 129
app/util
   acapy_issuer_utils.py18194%22
   acapy_verifier_utils.py137596%108–111, 191–195, 272
   assert_public_did.py181233%14–34
   check_endorser_connection.py10460%14–24
   credentials.py13285%11, 18
   retry_method.py363017%15–36, 68–114
   string.py15193%24
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14750%18–36
endorser/services
   endorsement_processor.py137696%90, 152–162
webhooks/models
   conversions.py63690%70, 83, 91, 112, 149, 168
webhooks/services
   acapy_events_processor.py1933283%98, 161–171, 194–208, 222, 229–235, 261, 289–290, 318–322, 335–339, 364–377
   billing_manager.py175498%91, 98–99, 132
   sse_manager.py2343685%155, 157–170, 208–218, 251–252, 265–279, 334–338, 344–347, 349–352, 377–378, 421–423, 457, 468–469
   webhooks_redis_service.py1401986%70, 237–238, 354, 378–398, 411–422
webhooks/tests/services
   test_acapy_events_processor.py161299%168–171
   test_sse_manager.py179398%214–215, 221
webhooks/web/routers
   sse.py102397%168–171
TOTAL15116156990% 

Tests Skipped Failures Errors Time
1083 39 💤 0 ❌ 0 🔥 8m 30s ⏱️

Copy link

sonarcloud bot commented Sep 13, 2024

@ff137 ff137 enabled auto-merge (squash) September 13, 2024 12:22
Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app/routes
   issuer.py185299%682–683
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1483378%100–102, 107, 167–169, 174, 250, 258–260, 265, 309–314, 320–322, 395–397, 403, 442–444, 449, 485–487, 543–545
   webhooks.py16475%32–36, 57–61
   websocket_endpoint.py23865%24–25, 37–42, 54–57, 70–76
app/routes/wallet
   credentials.py775232%32–45, 54–66, 75–86, 95–109, 120–136, 148–162, 171–183, 192–203
   jws.py422736%35–60, 76–99
   sd_jws.py422736%36–61, 78–101
app/services
   acapy_ledger.py611280%110–111, 124–140, 196–197
   acapy_wallet.py40490%60–61, 98–99
   revocation_registry.py1723580%118–160, 201–205, 372–376, 415–420, 453–457, 485–490, 539–540
   webhooks.py271833%17–25, 29–39
   websocket.py514120%19–22, 29–36, 47–91
app/services/event_handling
   websocket_manager.py732664%64–68, 87–90, 97–108, 115–125, 139
app/services/issuer
   acapy_issuer_v1.py871484%36, 76–110, 205–206
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
   tenants.py594524%30–98, 108–138
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py86397%100–102
   set_endorser_metadata.py724044%28–30, 50–52, 76–78, 109–128, 140–151, 163–176, 189–203
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/tests/e2e
   conftest.py23578%46–54
   test_connections.py149299%281–282
   test_jsonld.py591673%134–169
   test_proof_request_models.py31197%130
   test_tenants.py4201596%203, 247–248, 287, 788, 832–833, 842–843, 852–853, 865–866, 875–876
   test_wallet_credentials.py30197%55
   test_wallet_dids.py701086%101–116
app/tests/e2e/issuer
   test_get_records_paginated.py63297%66–67
   test_save_exchange_record.py74199%180
app/tests/e2e/verifier
   test_get_records_paginated.py62297%60–61
   test_proof_revoked_credential.py451273%130–203
   test_verifier.py2361295%691–762
app/tests/exception_handling
   test_handle_model_with_validation.py23196%22
app/tests/fixtures
   credentials.py1193769%176, 270–351, 364–436
   definitions.py662661%29–50, 64–65, 94–124, 143–144
   member_acapy_clients.py36489%47–50, 73–74
   member_connections.py43881%80–91, 130–141
   member_wallets.py611575%29–34, 49–54, 69–74, 89–94, 111–118
app/tests/routes/issuer
   test_create_offer.py39197%150
   test_send_credential.py36197%129
app/tests/routes/wallet/dids
   test_get_public_did.py29197%40
app/tests/services
   test_revocation_registry.py149299%75, 106
app/tests/services/issuer
   test_issuer.py160299%359–363
app/tests/util
   connections.py872967%104–129, 138–155, 172–181, 236–256
   ledger.py501080%35, 43, 55, 63–67, 77, 83
   regression_testing.py351751%33, 41–68, 74–81
   sse_listener.py41880%50–55, 79–84
   trust_registry.py29390%24, 27–28
   webhooks.py56591%20, 79–82, 105, 129
app/util
   acapy_issuer_utils.py18194%22
   acapy_verifier_utils.py137596%108–111, 191–195, 272
   assert_public_did.py18856%17–33
   credentials.py13285%11, 18
   retry_method.py361558%20–35, 76–77, 91–103
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14286%31–32
endorser/services
   endorsement_processor.py137696%90, 152–162
webhooks/models
   conversions.py63690%70, 83, 91, 112, 149, 168
webhooks/services
   acapy_events_processor.py1933283%98, 161–171, 194–208, 222, 229–235, 261, 289–290, 318–322, 335–339, 364–377
   billing_manager.py175498%91, 98–99, 132
   sse_manager.py2343685%155, 157–170, 208–218, 251–252, 265–279, 334–338, 344–347, 349–352, 377–378, 421–423, 457, 468–469
   webhooks_redis_service.py1401986%70, 237–238, 354, 378–398, 411–422
webhooks/tests/services
   test_acapy_events_processor.py161299%168–171
   test_sse_manager.py179398%214–215, 221
webhooks/web/routers
   sse.py102397%168–171
TOTAL1511692894% 

Tests Skipped Failures Errors Time
1083 4 💤 0 ❌ 0 🔥 4m 44s ⏱️

Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app/routes
   issuer.py185299%682–683
   jsonld.py604722%23–93, 104–137
   messaging.py241154%43–52, 85–95
   oob.py462839%58–99, 131–144, 170–181
   trust_registry.py62297%52–53
   verifier.py1483378%100–102, 107, 167–169, 174, 250, 258–260, 265, 309–314, 320–322, 395–397, 403, 442–444, 449, 485–487, 543–545
   webhooks.py16475%32–36, 57–61
   websocket_endpoint.py23865%24–25, 37–42, 54–57, 70–76
app/routes/wallet
   credentials.py775232%32–45, 54–66, 75–86, 95–109, 120–136, 148–162, 171–183, 192–203
   jws.py422736%35–60, 76–99
   sd_jws.py422736%36–61, 78–101
app/services
   acapy_ledger.py611969%43–49, 79, 110–111, 124–140, 146–149, 196–197
   acapy_wallet.py401270%49–64, 98–99
   revocation_registry.py1724673%118–160, 201–205, 372–376, 415–420, 453–457, 475–490, 496–505, 539–540
   webhooks.py271833%17–25, 29–39
   websocket.py514120%19–22, 29–36, 47–91
app/services/event_handling
   websocket_manager.py732664%64–68, 87–90, 97–108, 115–125, 139
app/services/issuer
   acapy_issuer_v1.py871484%36, 76–110, 205–206
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
   tenants.py594524%30–98, 108–138
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py86397%100–102
   set_endorser_metadata.py724044%28–30, 50–52, 76–78, 109–128, 140–151, 163–176, 189–203
app/services/trust_registry
   actors.py107992%95–100, 110, 209–210, 212–217, 282–285
   schemas.py54983%57–63, 89–99
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/tests/e2e
   conftest.py23578%46–54
   test_connections.py149299%281–282
   test_definitions.py795135%33–56, 68–80, 92–106, 118–146, 164–209
   test_jsonld.py591673%134–169
   test_proof_request_models.py31197%130
   test_revocation.py1117334%27–77, 90–107, 118–144, 156–181, 193–207, 219–256, 267–293, 305–335, 346–349
   test_tenants.py42036314%29–73, 84–117, 128–172, 185–254, 265–316, 329–458, 467–519, 528–564, 573–622, 631–680, 691–733, 745–794, 805–876, 885–992
   test_wallet_dids.py701579%101–116, 128–139
app/tests/e2e/issuer
   test_get_records_paginated.py635217%25–162
   test_save_exchange_record.py74199%180
app/tests/e2e/verifier
   test_get_credentials_by_proof_id.py251252%27–82
   test_get_records_paginated.py624921%27–156
   test_proof_revoked_credential.py451176%39–116
app/tests/exception_handling
   test_handle_model_with_validation.py23196%22
app/tests/fixtures
   credentials.py1195554%132–207, 216–224, 234–255, 289–349, 384–434
   definitions.py661085%41–48, 57–63, 114–121, 134–139
   member_acapy_clients.py36489%47–50, 73–74
   member_async_clients.py50296%32–33
   member_connections.py43491%73, 91, 123, 141
   member_wallets.py611575%23–27, 43–47, 63–67, 83–87, 103–109
app/tests/routes/issuer
   test_create_offer.py39197%150
   test_send_credential.py36197%129
app/tests/routes/wallet/dids
   test_get_public_did.py29197%40
app/tests/services
   test_revocation_registry.py149299%75, 106
app/tests/services/issuer
   test_issuer.py160299%359–363
app/tests/util
   connections.py871978%154–155, 169, 181, 191–223, 251–256
   ledger.py502648%34–59, 63–67, 73–86
   regression_testing.py35974%33, 60–68, 74–81
   sse_listener.py41880%50–55, 79–84
   tenants.py241250%10, 16–17, 21–26, 30–35, 39–44, 48–53, 57
   trust_registry.py29776%20–28
   webhooks.py56591%20, 79–82, 105, 129
app/util
   acapy_issuer_utils.py18194%22
   acapy_verifier_utils.py137596%108–111, 191–195, 272
   assert_public_did.py181233%14–34
   check_endorser_connection.py10460%14–24
   credentials.py13285%11, 18
   retry_method.py363017%15–36, 68–114
   string.py15193%24
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14750%18–36
endorser/services
   endorsement_processor.py137696%90, 152–162
webhooks/models
   conversions.py63690%70, 83, 91, 112, 149, 168
webhooks/services
   acapy_events_processor.py1933283%98, 161–171, 194–208, 222, 229–235, 261, 289–290, 318–322, 335–339, 364–377
   billing_manager.py175498%91, 98–99, 132
   sse_manager.py2343685%155, 157–170, 208–218, 251–252, 265–279, 334–338, 344–347, 349–352, 377–378, 421–423, 457, 468–469
   webhooks_redis_service.py1401986%70, 237–238, 354, 378–398, 411–422
webhooks/tests/services
   test_acapy_events_processor.py161299%168–171
   test_sse_manager.py179398%214–215, 221
webhooks/web/routers
   sse.py102397%168–171
TOTAL15116156990% 

Tests Skipped Failures Errors Time
1083 39 💤 0 ❌ 0 🔥 6m 56s ⏱️

@ff137 ff137 merged commit 908118d into development Sep 13, 2024
49 checks passed
@ff137 ff137 deleted the restrictions-on-proofs branch September 13, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants