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

📝 Update docstrings wallet/dids #817

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

cl0ete
Copy link
Collaborator

@cl0ete cl0ete commented May 24, 2024

Update wallet/did docstrings

@cl0ete cl0ete self-assigned this May 24, 2024
@cl0ete cl0ete added the documentation Improvements or additions to documentation label May 24, 2024
@cl0ete cl0ete changed the title WIP: Update docstrings WIP: Update docstrings wallet/dids May 24, 2024
@cl0ete cl0ete changed the title WIP: Update docstrings wallet/dids Update docstrings wallet/dids May 28, 2024
@cl0ete cl0ete marked this pull request as ready for review May 28, 2024 07:04
Copy link

Coverage

Coverage Report
FileStmtsMissCoverMissing
app/routes
   definitions.py20410648%107–189, 197–216, 261–350, 391–392, 450–466, 481–487, 508–517, 540–541, 558–560, 616–677, 721–722
   issuer.py1733878%95–97, 126, 189–191, 199, 216, 272, 285, 336, 409, 463, 585–616, 659–669, 715–726
   jsonld.py604722%23–93, 104–137
   messaging.py241154%32–41, 61–71
   oob.py462839%27–68, 79–92, 116–127
   verifier.py1473378%64–66, 71, 109–111, 116, 158, 166–168, 173, 207–212, 218–220, 270–272, 278, 311–313, 318, 348–350, 384–386
   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
   dids.py762271%46–55, 81–82, 112–113, 140–147, 170–178
   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.py1321291%314–318, 346, 356–361, 394–398, 426–431
   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, 197–198
   acapy_issuer_v2.py1012278%60–63, 87–127, 173, 219–220, 247
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.py49492%56–61, 91–96
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/tests/e2e
   conftest.py23578%46–54
   test_jsonld.py591673%134–169
   test_tenants.py3491596%186, 230–231, 263, 716, 754–755, 764–765, 774–775, 787–788, 797–798
   test_wallet_credentials.py30197%55
   test_wallet_dids.py691086%93–108
app/tests/e2e/issuer
   test_save_exchange_record.py72199%177
app/tests/e2e/verifier
   test_proof_revoked_credential.py461274%142–215
   test_verifier.py2311295%683–756
app/tests/exception_handling
   test_handle_model_with_validation.py23196%22
app/tests/fixtures
   credentials.py1203769%176, 271–352, 365–437
   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/services
   test_revocation_registry.py135299%73, 104
app/tests/services/issuer
   test_issuer.py160299%335–339
app/tests/util
   connections.py862769%114–139, 148–165, 182–191, 246–263
   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.py45491%19, 74–77, 100
app/util
   acapy_issuer_utils.py18194%22
   acapy_verifier_utils.py137596%108–111, 191–195, 272
   credentials.py13469%6, 11, 18, 21
   retry_method.py361558%20–35, 76–77, 91–103
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
endorser/services
   endorsement_processor.py137696%90, 152–162
webhooks/models
   conversions.py63690%70, 83, 91, 112, 149, 168
webhooks/services
   acapy_events_processor.py1862288%98, 161–171, 219–223, 251, 279–280, 308–312, 325–329, 354–367
   billing_manager.py175498%91, 98–99, 132
   sse_manager.py2353685%153, 155–168, 206–216, 245–246, 259–273, 328–332, 338–341, 343–346, 371–372, 415–417, 451, 462–463
   webhooks_redis_service.py1401986%70, 237–238, 354, 378–398, 411–422
webhooks/tests/services
   test_sse_manager.py180398%211–212, 218
webhooks/web/routers
   sse.py102397%168–171
TOTAL13294103992% 

Tests Skipped Failures Errors Time
892 10 💤 0 ❌ 0 🔥 9m 48s ⏱️

Copy link

sonarcloud bot commented Jun 3, 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

Copy link

github-actions bot commented Jun 3, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
app/routes
   definitions.py20410648%107–189, 197–216, 261–350, 391–392, 450–466, 481–487, 508–517, 540–541, 558–560, 616–677, 721–722
   issuer.py1733878%95–97, 126, 189–191, 199, 216, 272, 285, 336, 409, 463, 585–616, 659–669, 715–726
   jsonld.py604722%23–93, 104–137
   messaging.py241154%32–41, 61–71
   oob.py462839%27–68, 79–92, 116–127
   verifier.py1473378%64–66, 71, 109–111, 116, 158, 166–168, 173, 207–212, 218–220, 270–272, 278, 311–313, 318, 348–350, 384–386
   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
   dids.py762271%46–55, 81–82, 112–113, 140–147, 170–178
   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.py1321291%314–318, 346, 356–361, 394–398, 426–431
   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, 197–198
   acapy_issuer_v2.py1012278%60–63, 87–127, 173, 219–220, 247
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.py49492%56–61, 91–96
app/services/trust_registry/util
   actor.py31294%26–27
   issuer.py23483%39–40, 48–49
app/tests/e2e
   conftest.py23578%46–54
   test_jsonld.py591673%134–169
   test_tenants.py3491596%186, 230–231, 263, 716, 754–755, 764–765, 774–775, 787–788, 797–798
   test_wallet_credentials.py30197%55
   test_wallet_dids.py691086%93–108
app/tests/e2e/issuer
   test_save_exchange_record.py72199%177
app/tests/e2e/verifier
   test_proof_revoked_credential.py461274%142–215
   test_verifier.py2311295%683–756
app/tests/exception_handling
   test_handle_model_with_validation.py23196%22
app/tests/fixtures
   credentials.py1203769%176, 271–352, 365–437
   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/services
   test_revocation_registry.py135299%73, 104
app/tests/services/issuer
   test_issuer.py160299%335–339
app/tests/util
   connections.py862769%114–139, 148–165, 182–191, 246–263
   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.py45491%19, 74–77, 100
app/util
   acapy_issuer_utils.py18194%22
   acapy_verifier_utils.py137596%108–111, 191–195, 272
   credentials.py13469%6, 11, 18, 21
   retry_method.py361558%20–35, 76–77, 91–103
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
endorser/services
   endorsement_processor.py137696%90, 152–162
webhooks/models
   conversions.py63690%70, 83, 91, 112, 149, 168
webhooks/services
   acapy_events_processor.py1862288%98, 161–171, 219–223, 251, 279–280, 308–312, 325–329, 354–367
   billing_manager.py175498%91, 98–99, 132
   sse_manager.py2353685%153, 155–168, 206–216, 245–246, 259–273, 328–332, 338–341, 343–346, 371–372, 415–417, 451, 462–463
   webhooks_redis_service.py1401986%70, 237–238, 354, 378–398, 411–422
webhooks/tests/services
   test_sse_manager.py180398%211–212, 218
webhooks/web/routers
   sse.py102397%168–171
TOTAL13294103992% 

Tests Skipped Failures Errors Time
892 10 💤 0 ❌ 0 🔥 9m 11s ⏱️

@cl0ete cl0ete requested a review from ff137 June 11, 2024 08:52
@cl0ete cl0ete marked this pull request as draft June 18, 2024 13:27
@ff137 ff137 changed the title Update docstrings wallet/dids 📝 Update docstrings wallet/dids Jul 24, 2024
app/routes/wallet/dids.py Outdated Show resolved Hide resolved
app/routes/wallet/dids.py Show resolved Hide resolved
app/routes/wallet/dids.py Outdated Show resolved Hide resolved
app/routes/wallet/dids.py Outdated Show resolved Hide resolved
app/routes/wallet/dids.py Outdated Show resolved Hide resolved
app/routes/wallet/dids.py Outdated Show resolved Hide resolved
app/routes/wallet/dids.py Show resolved Hide resolved
app/routes/wallet/dids.py Outdated Show resolved Hide resolved
app/routes/wallet/dids.py Outdated Show resolved Hide resolved
@cl0ete cl0ete force-pushed the swagger-update-wallet-dids branch 3 times, most recently from a7757dc to c0f2cde Compare October 28, 2024 08:20
app/models/wallet.py Fixed Show fixed Hide fixed
app/models/wallet.py Fixed Show fixed Hide fixed
app/models/wallet.py Fixed Show fixed Hide fixed
Copy link

Coverage

K8s Test Coverage
FileStmtsMissCoverMissing
app
   main.py78297%117–118
app/models
   wallet.py26581%50–60
app/routes
   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.py1393376%88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
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.py1663579%118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
   tenants.py634922%30–103, 113–143
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py88397%103–105
   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_did_exchange.py732171%124–187
   test_jsonld.py591673%134–169
   test_proof_request_models.py24196%101
   test_tenants.py4211596%203, 247–248, 287, 789, 833–834, 843–844, 853–854, 866–867, 876–877
   test_wallet_credentials.py30197%55
   test_wallet_dids.py701086%101–116
app/tests/e2e/issuer
   test_get_records_paginated.py63297%65–66
   test_save_exchange_record.py72199%166
app/tests/e2e/verifier
   test_get_records_paginated.py62297%59–60
   test_many_revocations.py614034%31–107, 117–128, 139–214
   test_proof_revoked_credential.py441273%127–199
   test_verifier.py2241295%661–731
app/tests/exception_handling
   test_handle_model_with_validation.py23196%22
app/tests/fixtures
   credentials.py1203769%173, 268–348, 361–432
   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%145
   test_send_credential.py36197%125
app/tests/routes/wallet/dids
   test_get_public_did.py29197%40
app/tests/services
   test_revocation_registry.py141299%74, 105
app/tests/services/issuer
   test_issuer.py123298%281–285
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.py28486%51–56
   trust_registry.py29390%24, 27–28
   webhooks.py531572%19, 65–81, 88–90, 95, 119
app/util
   acapy_verifier_utils.py123596%81–84, 164–168, 245
   assert_public_did.py18856%17–33
   credentials.py14286%13, 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
   main.py50198%56
endorser/services
   endorsement_processor.py1081091%115–116, 202–213
endorser/tests
   test_util_endorsement.py144597%286, 291, 350–352
endorser/util
   endorsement.py68790%134–146
trustregistry
   main.py82495%46–48, 110
trustregistry/tests
   test_main.py137199%90
waypoint
   main.py48198%64
waypoint/tests/routers
   test_waypoint_sse.py83594%61–62, 120, 138, 174
waypoint/tests/services
   test_nats_service.py119397%46, 140, 162
TOTAL1249981893% 

Tests Skipped Failures Errors Time
835 6 💤 0 ❌ 0 🔥 2m 39s ⏱️

Copy link

Coverage

K8s Regression Test Coverage
FileStmtsMissCoverMissing
app
   main.py78297%117–118
app/models
   wallet.py26581%50–60
app/routes
   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.py1393376%88–90, 95, 152–154, 159, 231, 239–241, 246, 288–293, 299–301, 362–364, 369, 406–408, 413, 449–451, 505–507
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.py40490%60–61, 98–99
   revocation_registry.py1664672%118–160, 201–205, 360–364, 403–408, 441–445, 463–478, 484–493, 527–528
app/services/issuer
   acapy_issuer_v2.py1011288%63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
   tenants.py634922%30–103, 113–143
   verifier.py37392%67, 83–87
app/services/onboarding/util
   register_issuer_did.py88397%103–105
   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_did_exchange.py732171%124–187
   test_jsonld.py591673%134–169
   test_proof_request_models.py24196%101
   test_revocation.py1117334%27–77, 90–107, 118–144, 156–181, 193–207, 219–256, 267–293, 305–335, 346–349
   test_tenants.py42136414%29–73, 84–117, 128–172, 185–254, 265–316, 329–459, 468–520, 529–565, 574–623, 632–681, 692–734, 746–795, 806–877, 886–993
   test_wallet_dids.py701579%101–116, 128–139
app/tests/e2e/issuer
   test_get_records_paginated.py635217%25–161
   test_save_exchange_record.py72199%166
app/tests/e2e/verifier
   test_get_credentials_by_proof_id.py251252%27–81
   test_get_records_paginated.py624921%27–155
   test_many_revocations.py614034%31–107, 117–128, 139–214
   test_proof_revoked_credential.py441175%37–113
   test_verifier_oob.py682268%134–237
app/tests/exception_handling
   test_handle_model_with_validation.py23196%22
app/tests/fixtures
   credentials.py1205653%130–204, 213–221, 231–253, 287–346, 381–430
   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%145
   test_send_credential.py36197%125
app/tests/routes/wallet/dids
   test_get_public_did.py29197%40
app/tests/services
   test_revocation_registry.py141299%74, 105
app/tests/services/issuer
   test_issuer.py123298%281–285
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.py28486%51–56
   tenants.py241250%10, 16–17, 21–26, 30–35, 39–44, 48–53, 57
   trust_registry.py29776%20–28
   webhooks.py531572%19, 65–81, 88–90, 95, 119
app/util
   acapy_verifier_utils.py123596%81–84, 164–168, 245
   assert_public_did.py181233%14–34
   check_endorser_connection.py10460%14–24
   credentials.py14286%13, 18
   retry_method.py363017%15–36, 68–114
   string.py15473%15–16, 20, 24
   tenants.py451762%24–29, 44–45, 52–59, 90–91, 97, 124
   transaction_acked.py14750%18–36
endorser
   main.py50198%56
endorser/services
   endorsement_processor.py1081091%115–116, 202–213
endorser/tests
   test_util_endorsement.py144597%286, 291, 350–352
endorser/util
   endorsement.py68790%134–146
trustregistry
   main.py82495%46–48, 110
trustregistry/tests
   test_main.py137199%90
TOTAL12058146988% 

Tests Skipped Failures Errors Time
835 40 💤 0 ❌ 0 🔥 3m 37s ⏱️

Copy link

sonarcloud bot commented Nov 12, 2024

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