✨ Implement DID Exchange and DID Rotate methods and 🗑️ deprecate connections protocol #1119

ff137 · 2024-10-15T13:51:22Z

✨ Implements DID-Exchange and DID-Rotate methods in our Connections API
New endpoints under /connections:

/did-exchange/create-request
/did-exchange/accept-request
/did-exchange/reject
/did-rotate
/did-rotate/hangup

🗑️ Deprecates the following endpoints:

/connections/create-invitation
/connections/accept-invitation

✅ Includes e2e and unit test coverage

🎉 Upgraded cloudcontroller now allows Create Local DID support for: did:web, did:peer2, did:peer:4

Closes #910

app/routes/connections.py

app/tests/e2e/test_did_exchange.py

github-actions · 2024-10-16T17:50:11Z

K8s Test Coverage

File	Stmts	Miss	Cover	Missing
app
main.py	78	2	97%	117–118
app/routes
connections.py	98	33	66%	348–380, 407–422, 446–459, 490–502, 529–540
jsonld.py	60	47	22%	23–93, 104–137
messaging.py	24	11	54%	43–52, 85–95
oob.py	46	28	39%	58–99, 131–144, 170–181
trust_registry.py	62	2	97%	52–53
verifier.py	139	33	76%	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.py	77	52	32%	32–45, 54–66, 75–86, 95–109, 120–136, 148–162, 171–183, 192–203
jws.py	42	27	36%	35–60, 76–99
sd_jws.py	42	27	36%	36–61, 78–101
app/services
acapy_ledger.py	61	12	80%	110–111, 124–140, 196–197
acapy_wallet.py	40	4	90%	60–61, 98–99
revocation_registry.py	166	35	79%	118–160, 201–205, 360–364, 403–408, 441–445, 473–478, 527–528
app/services/issuer
acapy_issuer_v2.py	101	12	88%	63, 97–106, 110, 126–127, 173, 227–228, 255
app/services/onboarding
tenants.py	63	49	22%	30–103, 113–143
verifier.py	37	3	92%	67, 83–87
app/services/onboarding/util
register_issuer_did.py	86	3	97%	100–102
set_endorser_metadata.py	72	40	44%	28–30, 50–52, 76–78, 109–128, 140–151, 163–176, 189–203
app/services/trust_registry
actors.py	107	9	92%	95–100, 110, 209–210, 212–217, 282–285
schemas.py	54	9	83%	57–63, 89–99
app/services/trust_registry/util
actor.py	31	2	94%	26–27
issuer.py	23	4	83%	39–40, 48–49
app/tests/e2e
conftest.py	23	5	78%	46–54
test_connections.py	149	2	99%	281–282
test_jsonld.py	59	16	73%	134–169
test_proof_request_models.py	24	1	96%	101
test_tenants.py	421	15	96%	203, 247–248, 287, 789, 833–834, 843–844, 853–854, 866–867, 876–877
test_wallet_credentials.py	30	1	97%	55
test_wallet_dids.py	70	10	86%	101–116
app/tests/e2e/issuer
test_get_records_paginated.py	63	2	97%	65–66
test_save_exchange_record.py	72	1	99%	166
app/tests/e2e/verifier
test_get_records_paginated.py	62	2	97%	59–60
test_many_revocations.py	61	40	34%	31–107, 117–128, 139–214
test_proof_revoked_credential.py	44	12	73%	127–199
test_verifier.py	224	12	95%	661–731
app/tests/exception_handling
test_handle_model_with_validation.py	23	1	96%	22
app/tests/fixtures
credentials.py	120	37	69%	173, 268–348, 361–432
definitions.py	66	26	61%	29–50, 64–65, 94–124, 143–144
member_acapy_clients.py	36	4	89%	47–50, 73–74
member_connections.py	43	8	81%	80–91, 130–141
member_wallets.py	61	15	75%	29–34, 49–54, 69–74, 89–94, 111–118
app/tests/routes/issuer
test_create_offer.py	39	1	97%	145
test_send_credential.py	36	1	97%	125
app/tests/routes/wallet/dids
test_get_public_did.py	29	1	97%	40
app/tests/services
test_revocation_registry.py	141	2	99%	74, 105
app/tests/services/issuer
test_issuer.py	123	2	98%	281–285
app/tests/util
connections.py	87	29	67%	104–129, 138–155, 172–181, 236–256
ledger.py	50	10	80%	35, 43, 55, 63–67, 77, 83
regression_testing.py	35	17	51%	33, 41–68, 74–81
sse_listener.py	28	4	86%	51–56
trust_registry.py	29	3	90%	24, 27–28
webhooks.py	53	15	72%	19, 65–81, 88–90, 95, 119
app/util
acapy_verifier_utils.py	123	5	96%	81–84, 164–168, 245
assert_public_did.py	18	8	56%	17–33
credentials.py	14	2	86%	13, 18
retry_method.py	36	15	58%	20–35, 76–77, 91–103
tenants.py	45	17	62%	24–29, 44–45, 52–59, 90–91, 97, 124
transaction_acked.py	14	2	86%	31–32
endorser
main.py	37	1	97%	55
endorser/services
endorsement_processor.py	94	2	98%	110–111
endorser/tests
test_util_endorsement.py	144	5	97%	286, 291, 350–352
endorser/util
endorsement.py	68	7	90%	134–146
trustregistry
main.py	82	4	95%	46–48, 110
trustregistry/tests
test_main.py	137	1	99%	90
waypoint
main.py	48	1	98%	64
waypoint/tests/routers
test_waypoint_sse.py	83	5	94%	61–62, 119, 136, 171
waypoint/tests/services
test_nats_service.py	116	3	97%	45, 133, 155
TOTAL	12174	817	93%

Tests	Skipped	Failures	Errors	Time
803	5 💤	0 ❌	0 🔥	3m 6s ⏱️

* `xk6-sse` isn't compatible with `k6>=0.53` * Pin `xk6` and all plugins to the latest compatible versions * Also bump Golang to `1.23`

app/tests/e2e/test_did_rotate.py

…to get bloated

sonarcloud · 2024-10-17T14:48:32Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

…ections protocol (#1119) * 🗑️ mark deprecated routes * 🚧 initial implementation of new did-exchange routes * 🎨 modify default extra settings example * 🔧 Update default pylint config * 🎨 update docstrings and available optional params * 🚧 e2e test under construction * ✅ fix up create request tests * 🐛 fix protocol: /1.1 doesn't work ... * 🐛 use_public_did must be false in accept-request * ✅ working tests for accept-request * 🎨 remove unused endpoint and update route names * 🎨 update route names * 🎨 accept reject reason sa body instead of param * ⬆️ Use latest cloudcontroller * ⬆️ Update lock files * ✨ implement did-rotate endpoints * 🔧 add max-positional-arguments to pylintrc * ⬆️ use latest cloudcontroller * ⬆️ Update lock files * ✨ Use did-rotate/hangup in deletion of connection record (if using didexchange protocol) * ✅ Fix deleting records when using oob connections * ✅ assert connections are complete for both parties * ✅ e2e tests for did-rotate * ⬆️ Helmfile `0.169`, Helm `3.16.2`, Tailscale `1.76.0` (#1123) * 📌 Pin `xk6` and plugin versions (#1124) * `xk6-sse` isn't compatible with `k6>=0.53` * Pin `xk6` and all plugins to the latest compatible versions * Also bump Golang to `1.23` * 📌 Explicitly pin k6 to `v0.52.0` (#1125) * ⬆️ Update lock files * 🎨 * ✅ 100% unit test coverage for new did-exchange and did-rotate methods * ✅ fixed up delete connection test * 🐛 Reconfigure ACAPY_AUTO_ACCEPT_REQUESTS for Faber after test completes * ✅ add cleaning up of connection records, for regression fixtures not to get bloated --------- Co-authored-by: Robbie Blaine <4052340+rblaine95@users.noreply.github.com>

* add max attempts env * 🎨 * must be int * reset to 15 * add temp debug log * more temp debug logs * dont reset nats * revert reset nats * remove temp debug logging * add heartbeat to fetch * import fetch time out error * on fetch timeout continue * on generic timeout re-subscribe * update imports * fix test * add tests for health endpoints * update health endpoints * add check jetstream func for health checks * fix test * 🎨 * update endorser health endpoint * ✨ Implement DID Exchange and DID Rotate methods and 🗑️ deprecate connections protocol (#1119) * 🗑️ mark deprecated routes * 🚧 initial implementation of new did-exchange routes * 🎨 modify default extra settings example * 🔧 Update default pylint config * 🎨 update docstrings and available optional params * 🚧 e2e test under construction * ✅ fix up create request tests * 🐛 fix protocol: /1.1 doesn't work ... * 🐛 use_public_did must be false in accept-request * ✅ working tests for accept-request * 🎨 remove unused endpoint and update route names * 🎨 update route names * 🎨 accept reject reason sa body instead of param * ⬆️ Use latest cloudcontroller * ⬆️ Update lock files * ✨ implement did-rotate endpoints * 🔧 add max-positional-arguments to pylintrc * ⬆️ use latest cloudcontroller * ⬆️ Update lock files * ✨ Use did-rotate/hangup in deletion of connection record (if using didexchange protocol) * ✅ Fix deleting records when using oob connections * ✅ assert connections are complete for both parties * ✅ e2e tests for did-rotate * ⬆️ Helmfile `0.169`, Helm `3.16.2`, Tailscale `1.76.0` (#1123) * 📌 Pin `xk6` and plugin versions (#1124) * `xk6-sse` isn't compatible with `k6>=0.53` * Pin `xk6` and all plugins to the latest compatible versions * Also bump Golang to `1.23` * 📌 Explicitly pin k6 to `v0.52.0` (#1125) * ⬆️ Update lock files * 🎨 * ✅ 100% unit test coverage for new did-exchange and did-rotate methods * ✅ fixed up delete connection test * 🐛 Reconfigure ACAPY_AUTO_ACCEPT_REQUESTS for Faber after test completes * ✅ add cleaning up of connection records, for regression fixtures not to get bloated --------- Co-authored-by: Robbie Blaine <4052340+rblaine95@users.noreply.github.com> * 💩 add sleep to avoid mysterious 500 error --------- Co-authored-by: Mourits de Beer <31511766+ff137@users.noreply.github.com> Co-authored-by: Robbie Blaine <4052340+rblaine95@users.noreply.github.com> Co-authored-by: ff137 <ff137@proton.me>

ff137 added 3 commits October 15, 2024 15:29

🗑️ mark deprecated routes

683ff4f

🚧 initial implementation of new did-exchange routes

5389c3e

🎨 modify default extra settings example

d802f8d

github-advanced-security bot found potential problems Oct 15, 2024

View reviewed changes

app/routes/connections.py Fixed Show fixed Hide fixed

app/routes/connections.py Fixed Show fixed Hide fixed

app/routes/connections.py Fixed Show fixed Hide fixed

app/routes/connections.py Fixed Show fixed Hide fixed

app/routes/connections.py Fixed Show fixed Hide fixed

ff137 added 4 commits October 16, 2024 13:26

🔧 Update default pylint config

1a0fb89

🎨 update docstrings and available optional params

fe84965

Merge branch 'development' into deprecate-connections-protocol

1a03b13

🚧 e2e test under construction

3ff0975

github-advanced-security bot found potential problems Oct 16, 2024

View reviewed changes

app/tests/e2e/test_did_exchange.py Fixed Show fixed Hide fixed

ff137 added 7 commits October 16, 2024 14:51

✅ fix up create request tests

d088cb1

🐛 fix protocol: /1.1 doesn't work ...

cc65e7c

🐛 use_public_did must be false in accept-request

a3511cc

✅ working tests for accept-request

bac484e

🎨 remove unused endpoint and update route names

3db3d6a

🎨 update route names

1de0a29

🎨 accept reject reason sa body instead of param

286725b

github-advanced-security bot found potential problems Oct 16, 2024

View reviewed changes

app/tests/e2e/test_did_exchange.py Fixed Show fixed Hide fixed

ff137 added 4 commits October 16, 2024 20:19

⬆️ Use latest cloudcontroller

dc076fb

⬆️ Update lock files

cdf5532

✨ implement did-rotate endpoints

d2eaf42

🔧 add max-positional-arguments to pylintrc

dd7614a

ff137 self-assigned this Oct 16, 2024

ff137 added the enhancement New feature or request label Oct 16, 2024

ff137 marked this pull request as ready for review October 16, 2024 17:34

ff137 requested a review from cl0ete October 16, 2024 17:34

ff137 changed the title ~~🚧 Deprecate connections protocol and implement DID Exchange and DID Rotate methods~~ ✨ Implement DID Exchange and DID Rotate methods and 🗑️ deprecate connections protocol Oct 16, 2024

ff137 temporarily deployed to dev October 16, 2024 17:40 — with GitHub Actions Inactive

ff137 temporarily deployed to dev October 16, 2024 17:43 — with GitHub Actions Inactive

ff137 and others added 7 commits October 17, 2024 14:58

✅ assert connections are complete for both parties

0dc5f5c

✅ e2e tests for did-rotate

a263b7d

⬆️ Helmfile 0.169, Helm 3.16.2, Tailscale 1.76.0 (#1123)

da57618

📌 Pin xk6 and plugin versions (#1124)

5285d96

* `xk6-sse` isn't compatible with `k6>=0.53` * Pin `xk6` and all plugins to the latest compatible versions * Also bump Golang to `1.23`

📌 Explicitly pin k6 to v0.52.0 (#1125)

e271c31

⬆️ Update lock files

5624a91

Merge branch 'development' into deprecate-connections-protocol

7228221

github-advanced-security bot found potential problems Oct 17, 2024

View reviewed changes

app/tests/e2e/test_did_rotate.py Fixed Show fixed Hide fixed

🎨

baf9ad9

ff137 had a problem deploying to dev October 17, 2024 13:38 — with GitHub Actions Error

ff137 temporarily deployed to dev October 17, 2024 13:40 — with GitHub Actions Inactive

ff137 temporarily deployed to dev October 17, 2024 13:43 — with GitHub Actions Inactive

ff137 had a problem deploying to dev October 17, 2024 13:43 — with GitHub Actions Failure

ff137 added 2 commits October 17, 2024 16:01

✅ 100% unit test coverage for new did-exchange and did-rotate methods

d1f52bf

✅ fixed up delete connection test

cd9ae6f

github-advanced-security bot found potential problems Oct 17, 2024

View reviewed changes

app/tests/e2e/test_did_rotate.py Dismissed Show dismissed Hide dismissed

ff137 temporarily deployed to dev October 17, 2024 14:13 — with GitHub Actions Inactive

ff137 temporarily deployed to dev October 17, 2024 14:17 — with GitHub Actions Inactive

ff137 had a problem deploying to dev October 17, 2024 14:17 — with GitHub Actions Failure

ff137 added 2 commits October 17, 2024 16:26

🐛 Reconfigure ACAPY_AUTO_ACCEPT_REQUESTS for Faber after test completes

9b573d2

✅ add cleaning up of connection records, for regression fixtures not …

bf87889

…to get bloated

ff137 temporarily deployed to dev October 17, 2024 14:48 — with GitHub Actions Inactive

ff137 had a problem deploying to dev October 17, 2024 14:52 — with GitHub Actions Error

ff137 temporarily deployed to dev October 17, 2024 14:52 — with GitHub Actions Inactive

ff137 merged commit c78bd72 into development Oct 17, 2024
45 of 46 checks passed

ff137 deleted the deprecate-connections-protocol branch October 17, 2024 15:06

ff137 mentioned this pull request Oct 17, 2024

🧪 Skip test which modifies Faber wallet settings #1126

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Implement DID Exchange and DID Rotate methods and 🗑️ deprecate connections protocol #1119

✨ Implement DID Exchange and DID Rotate methods and 🗑️ deprecate connections protocol #1119

ff137 commented Oct 15, 2024 •

edited

Loading

github-actions bot commented Oct 16, 2024

sonarcloud bot commented Oct 17, 2024

✨ Implement DID Exchange and DID Rotate methods and 🗑️ deprecate connections protocol #1119

✨ Implement DID Exchange and DID Rotate methods and 🗑️ deprecate connections protocol #1119

Conversation

ff137 commented Oct 15, 2024 • edited Loading

github-actions bot commented Oct 16, 2024

sonarcloud bot commented Oct 17, 2024

Quality Gate passed

ff137 commented Oct 15, 2024 •

edited

Loading