feat(custom_targets): handle embedded credentials, enable tests #188

andrewazores · 2023-11-23T16:50:04Z

Welcome to Cryostat3! 👋

Before contributing, make sure you have:

Read the contributing guidelines
Linked a relevant issue which this PR resolves
Linked any other relevant issues, PR's, or documentation, if any
Resolved all conflicts, if any
Rebased your branch PR on top of the latest upstream main branch
Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
Signed all commits using a GPG signature

To recreate commits with GPG signature git fetch upstream && git rebase --force --gpg-sign upstream/main

Fixes #101
Related to #122
Based on #183
Depends on #183

Description of the change:

Re-enables the Custom Targets integration test that was ported over earlier. Along with this come some fixes to the initial 3.0 implementation so that the API responses match the pre-existing format, addition of handling of "embedded credentials" supplied with Custom Targets definitions, addition of handling to look up existing credentials from the keyring when opening a target connection, fixes to ensure that WebSocket messages are emitted in a more predictable order for clients to observe, some basic refactoring, and putting back the three instances of vertx-fib-demo like the old smoketest has.

How to manually test:

Build PR locally, ./mvnw clean verify ; podman image prune -f and ensure all tests pass
./smoketest.bash -OXgtb or whichever combination of flags you like
Go to Dashboard > Create Target view, try to create a new custom target. This will need to have a unique but existing/reachable JMX URL, so you can use service:jmx:rmi:///jndi/rmi://vertx-fib-demo-2:9094/jmxrmi. In the latest smoketest script, vertx-fib-demo-n and sample-app-n (n: [1, 2, 3]) are basically synonymous - both forms are resolvable hostnames from the perspective of the cryostat3 container. vertx-fib-demo-2:9094 and vertx-fib-demo-3:9095 are free to use as custom targets, the other URLs will be automatically discovered by JDP and the samples' Agent instances.

With service:jmx:rmi:///jndi/rmi://vertx-fib-demo-2:9094/jmxrmi:

Go to target creation view, enter this URL
Test connection. It should fail due to missing credentials.
Add the credentials admin:adminpass123 in the form, test the connection again. It should succeed.
Replace the credentials with user:password, test again. It should still succeed.
Replace the credentials with something else, test again. It should fail.
Put back user:password and create the custom target. This should succeed and some notifications should appear. You will be brought back to the Topology view, which depends on GraphQL ([Story] GraphQL #11), so don't worry about that view being broken for now.
Go to Recordings and try to create a new flight recording. This should fail with an HTTP 403.
Go to Security and delete the credentials that match the JMX URL. Create new credentials with the same match expression, but this time using the admin:adminpass123 combination.
Go back to Recordings and retry creating a recording. This should succeed.

With service:jmx:rmi:///jndi/rmi://vertx-fib-demo-3:9095/jmxrmi:

Go to target creation view, enter this URL
Test connection. It should fail due to "non-JRMP endpoint" - this is a little misleading but actually indicates the unknown SSL cert required by this test app instance.
Creating the target should similarly fail.

With service:jmx:rmi:///jndi/rmi://cryostat3:9091/jmxrmi:

Go to target creation view, enter this URL
Test connection. This should succeed.
Creating the target should succeed. Cryostat should succeed at automatically connecting to itself and via this URL you should also see the onstart recording that is already present.

Note: deleting a Custom Target is only exposed in the UI via the Topology view, so there is no way to undo this graphically yet. You can either tear down and restart the smoketest to get a fresh slate, or you can use curl/HTTPie and delete the custom target directly via the API:

$ http --auth=user:pass :8181/api/v3/targets
HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Type: application/json;charset=UTF-8
content-encoding: gzip
content-length: 1762

[
    ...
    {
        "agent": false,
        "alias": "service%3Ajmx%3Armi%3A%2F%2F%2Fjndi%2Frmi%3A%2F%2Fvertx-fib-demo-2%3A9094%2Fjmxrmi",
        "annotations": {
            "cryostat": {
                "REALM": "Custom Targets"
            },
            "platform": {}
        },
        "connectUrl": "service:jmx:rmi:///jndi/rmi://vertx-fib-demo-2:9094/jmxrmi",
        "id": 9,
        "jvmId": "hk58o_x3gJT4jK0aLmd5XdBRrdIRKmHb3xKZKixAQDI=",
        "labels": {}
    }
]

$ http --auth=user:pass DELETE :8181/api/v3/targets/9
HTTP/1.1 204 No Content
content-encoding: identity

andrewazores · 2023-11-23T16:50:56Z

/build_test

github-actions · 2023-11-23T16:51:17Z

Workflow started at 11/23/2023, 11:51:16 AM. View Actions Run.

github-actions · 2023-11-23T16:53:34Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/6972468439

github-actions · 2023-11-23T16:57:19Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/6972468439

andrewazores · 2023-11-27T22:13:03Z

/build_test

github-actions · 2023-11-27T22:13:25Z

Workflow started at 11/27/2023, 5:13:25 PM. View Actions Run.

github-actions · 2023-11-27T22:15:48Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/7011255699

github-actions · 2023-11-27T22:19:31Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/7011255699

github-actions · 2023-11-28T15:06:27Z

This PR/issue depends on:

~~feat(recordings): implement PATCH recordingOptions #183~~
By Dependent Issues (🤖). Happy coding!

andrewazores · 2023-11-28T15:14:02Z

/build_test

github-actions · 2023-11-28T15:14:23Z

Workflow started at 11/28/2023, 10:14:22 AM. View Actions Run.

github-actions · 2023-11-28T15:16:39Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/7020796882

github-actions · 2023-11-28T15:20:27Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/7020796882

andrewazores · 2023-11-28T15:39:10Z

/build_test

github-actions · 2023-11-28T15:39:38Z

Workflow started at 11/28/2023, 10:39:38 AM. View Actions Run.

github-actions · 2023-11-28T15:43:17Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/7021132421

github-actions · 2023-11-28T15:46:40Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/7021132421

…st target cleanup

…n order

…error cases (no ".data.result")

…eed to evaluate matching credentials for it for the first time

andrewazores · 2023-12-15T19:40:20Z

/build_test

github-actions · 2023-12-15T19:40:40Z

Workflow started at 12/15/2023, 2:40:39 PM. View Actions Run.

github-actions · 2023-12-15T19:46:59Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/7226342002

github-actions · 2023-12-15T19:49:35Z

CI build and push: All tests pass ✅
https://github.com/cryostatio/cryostat3/actions/runs/7226342002

…ts (cryostatio#188)" This reverts commit 539940e.

andrewazores added feat New feature or request safe-to-test labels Nov 23, 2023

github-actions bot added the dependent label Nov 23, 2023

andrewazores marked this pull request as draft November 23, 2023 16:50

andrewazores force-pushed the custom-targets branch from 38c128f to 3bcd359 Compare November 27, 2023 17:45

andrewazores force-pushed the custom-targets branch from 3640144 to 856917f Compare November 28, 2023 15:06

github-actions bot removed the dependent label Nov 28, 2023

andrewazores force-pushed the custom-targets branch from 856917f to e7f0e68 Compare November 28, 2023 15:38

andrewazores marked this pull request as ready for review November 28, 2023 15:39

andrewazores requested review from aali309 and mwangggg November 28, 2023 15:44

andrewazores force-pushed the custom-targets branch from e7f0e68 to 68896c7 Compare November 28, 2023 15:55

andrewazores marked this pull request as draft November 28, 2023 18:21

andrewazores added 21 commits December 15, 2023 14:39

check for stored credentials when opening target connections

d85fb10

refactor to use redirect-handling webClient extensions, ensure selfte…

833bb7b

…st target cleanup

fixup test class

86dc577

fix(messaging): handle writing to websockets on dedicated worker thread

07c5a57

enhance websocket expectation logging and closure handling

b9088c5

correct custom target notification expectations for 3.0 event emissio…

ed33b94

…n order

don't try to create credentials if none specified

d5425e8

refactor to handle ".data.reason" format of API V2 JSON responses in …

5ad43d2

…error cases (no ".data.result")

deploy 3 vertx-fib-demo samples, one with auth, one with auth+ssl

10e8c01

bust connection cache entries if matching credentials change

74cddfb

refactor, extract method

3a030dd

handle uncaught JMX ConnectionException as a 502 BAD GATEWAY

5d667af

better error message formatting

62d416f

fixup! bust connection cache entries if matching credentials change

b7e7a4a

permit null JVM IDs, target may not have been connectable yet if we n…

1122499

…eed to evaluate matching credentials for it for the first time

formatting

c1676d4

clean up handling of connection testing and credentials

2686b9e

handle JMX auth failure as HTTP 403 Forbidden

948c45b

fix concurrent modification exception

e5354d6

drop gson dependency

d086116

append, not override, sample app java opts

cea1f36

andrewazores force-pushed the custom-targets branch from 1a5f3a5 to cea1f36 Compare December 15, 2023 19:40

andrewazores merged commit 539940e into cryostatio:main Dec 15, 2023
8 checks passed

andrewazores deleted the custom-targets branch December 15, 2023 19:51

andrewazores mentioned this pull request Dec 19, 2023

[CI] Test suite failures #216

Closed

andrewazores added a commit to andrewazores/cryostat3 that referenced this pull request Dec 19, 2023

Revert "feat(custom_targets): handle embedded credentials, enable tes…

57f7e0f

…ts (cryostatio#188)" This reverts commit 539940e.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(custom_targets): handle embedded credentials, enable tests #188

feat(custom_targets): handle embedded credentials, enable tests #188

andrewazores commented Nov 23, 2023 •

edited

Loading

andrewazores commented Nov 23, 2023

github-actions bot commented Nov 23, 2023

github-actions bot commented Nov 23, 2023

github-actions bot commented Nov 23, 2023

andrewazores commented Nov 27, 2023

github-actions bot commented Nov 27, 2023

github-actions bot commented Nov 27, 2023

github-actions bot commented Nov 27, 2023

github-actions bot commented Nov 28, 2023

andrewazores commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

andrewazores commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

andrewazores commented Dec 15, 2023

github-actions bot commented Dec 15, 2023

github-actions bot commented Dec 15, 2023

github-actions bot commented Dec 15, 2023

feat(custom_targets): handle embedded credentials, enable tests #188

feat(custom_targets): handle embedded credentials, enable tests #188

Conversation

andrewazores commented Nov 23, 2023 • edited Loading

Welcome to Cryostat3! 👋

Before contributing, make sure you have:

Description of the change:

How to manually test:

andrewazores commented Nov 23, 2023

github-actions bot commented Nov 23, 2023

github-actions bot commented Nov 23, 2023

github-actions bot commented Nov 23, 2023

andrewazores commented Nov 27, 2023

github-actions bot commented Nov 27, 2023

github-actions bot commented Nov 27, 2023

github-actions bot commented Nov 27, 2023

github-actions bot commented Nov 28, 2023

andrewazores commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

andrewazores commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

github-actions bot commented Nov 28, 2023

andrewazores commented Dec 15, 2023

github-actions bot commented Dec 15, 2023

github-actions bot commented Dec 15, 2023

github-actions bot commented Dec 15, 2023

andrewazores commented Nov 23, 2023 •

edited

Loading