Make WireMock extension for Quarkus an official Dev Service
Opened this issue · 21 comments
Congrats with the 1.0.0 release @chberger !
This extension looks like a Dev Service, smells like a DevService, and also behaves and gets configured as a Dev Service. But formally it is not one at the moment. It would be great to make it more official and have it listed on https://quarkus.io/guides/dev-services and within the Quarkus app.
I'd be happy to help with documentation and whatever needed for it
Proposal
- Add extension to https://quarkus.io/guides/dev-services - quarkusio/quarkus#39913
- Reference the extension tutorial from proper Dev Services locations, e.g. in https://quarkus.io/guides/getting-started-testing
- Add the extension to the Dev Services list in Dev UI
Quarkus Dev UI
Right now the extension is not listed as a dev service
Hi @oleg-nenashev, many thanks! 🚀
I really like your proposal! 👍 However, I'm not sure whether the Quarkus team will actually list external Dev Services in their guides. I have the impression that all Dev Services currently mentioned are part of the core platform.
Anyway, feel free to get in touch with the Quarkus team. Maybe it is actually conceivable ... 🤞
Regarding your last point I've created a PR which addresses this issue: #72. I would be delighted if you would review it.
Cc @maxandersen @aloubyansky for the dev service criteria. On behalf of the WireMock community, would be happy to cooperate on that
We already have neo4j listed.
If gets to be issue we'll fix it and make it work.
I've raised quarkusio/quarkusio.github.io#1869 for a discussion of listing more dev services on https://quarkus.io/guides/dev-services.
Hi @chberger could you please send me your contact email address (my one is public in the profile - o.v.nenashev at gmail dot com)? I would like to add you directly to the email conversation with @holly-cummins that we started on this subject
@chberger This is being labeled as stale.
@chberger This is being closed due to inactivity.
@chberger could you please reopen it?
@oleg-nenashev thanks for the hint
- I've raised quarkusio/quarkus#39913 to list the WireMock extension in the list of dev services
- For https://quarkus.io/guides/getting-started-testing, it looks like the page mentions WireMock a few times, and should be updated to refer to the extension instead. Perhaps @oleg-nenashev or @chberger could do a PR?
- For the Dev UI, this information is automagically pulled from what's in the extension. @phillip-kruger, is the dev services information supposed to be automatically populated if an extension has a dev service, or do the WireMock team need to work through some of the steps in https://quarkus.io/guides/dev-ui?
Oh, and I thought I already commented, but I can't find it, so maybe not. As a general terminology clarification, a dev service is just the ability to start a zero-configuration container; some extensions do, and some don't. It's not a description of extension status or something extensions get nominated to be.
@holly-cummins yes that should happen automatically. As long as they produce io.quarkus.deployment.dev.devservices.DevServiceDescriptionBuildItem. See https://github.com/quarkusio/quarkus/blob/c24cfd708ba71c285b0b7459ee2e5956124e3b7b/extensions/vertx-http/deployment/src/main/java/io/quarkus/devui/deployment/menu/DevServicesProcessor.java#L27
Thanks, @phillip-kruger! I can see the dev services description build item in the code, so I guess the next thing is to confirm if the dev service is still missing from the UI.
I've just checked (sorry, I should have done that before asking you, @phillip-kruger!), and I can see it in my dev UI:
@oleg-nenashev, is it still missing for you?
@holly-cummins it was added by @chberger in 1.1.0 - #72 . Sorry, this ticket is a bit dated, will update
See https://quarkus.io/version/main/guides/dev-services for the new guide content. So I think it's just mentioning the extension in https://quarkus.io/guides/getting-started-testing which is outstanding.
@chberger This is being labeled as stale.
Not stale but still needs a few steps
@chberger This is being labeled as stale.
The one outstanding item for this item is adding something to https://quarkus.io/guides/getting-started-testing. I never know exactly how much the guides should be about the core/platform, and how much they should include the whole Quarkiverse, but independently of that question, this bit in the guide seems definitely wrong:
Common cases include starting docker containers using Testcontainers (an example of which can be found here), or starting a mock HTTP server using Wiremock (an example of which can be found here).
We wouldn't expect people to use a test resource for WireMock, because there's an extension. So the text wants changing, maybe to find a different example of user-managed resources. And @geoand, I wonder if the code example should be updated?
Yeah, we can definitely update that