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

Upgrade to Quarkus Antora 1.0.0, use AntorAssured for validating links #1660

Merged
merged 1 commit into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ include::example$ws-trust/application.properties[tag=ws-trust-usage.adoc-client-
====
The properties for configuring the STS client are provided by the `io.quarkiverse.cxf:quarkus-cxf-rt-ws-security`
extension and documented on its
xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client[reference page].
xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-sts-client[reference page].
====

Alternatively, the client can be set as a bean reference:
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/release-notes/2.6.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ See https://github.com/quarkiverse/quarkus-cxf/issues/1047[#1047]
=== Configurable destination folder of `wsdl2java`

The directory where the xref:user-guide/contract-first-code-first/generate-java-from-wsdl.adoc[`wsdl2java` embedded in `quarkus-cxf`] extension produces the Java classes is now configurable
via the `xref:reference/extensions/quarkus-cxf#quarkus-cxf_quarkus.cxf.codegen.wsdl2java.output-directory[quarkus.cxf.codegen.wsdl2java.output-directory]` property.
via the `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-output-directory[quarkus.cxf.codegen.wsdl2java.output-directory]` property.

=== Possible thread leaks with CXF clients using `java.net.http.HttpClient`

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/release-notes/3.16.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ quarkus.cxf.client.hello.trust-store-password = client-truststore-password

=== Vert.x HttpClient based HTTP Conduit is the new default

Vert.x HttpClient based HTTP Conduit was xref:release-notes/3.13.0.adoc#_vert_x_httpclient_based_http_conduit[introduced] in {quarkus-cxf-project-name} 3.13.0.
Vert.x HttpClient based HTTP Conduit was xref:release-notes/3.13.0.adoc#vert-x-httpclient-based-http-conduit[introduced] in {quarkus-cxf-project-name} 3.13.0.
Its usage was optional through setting the `VertxHttpClientHTTPConduitFactory` on either of the options
`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-client-client-name-http-conduit-factory[quarkus.cxf.client."client-name".http-conduit-factory]` or
`xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-http-conduit-factory[quarkus.cxf.http-conduit-factory]`:
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/release-notes/3.8.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following parts of the documentation were improved:

* The Reference page now contains xref:reference/index.adoc#supported-cxf-annotations[List of supported CXF annotations].
* xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc[WS-Security extension page]
** New example using xref:reference/index.adoc#extensions-quarkus-cxf-rt-ws-security-usage-ws-security-via-ws-securitypolicy[WS-SecurityPolicy]
** New example using xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#extensions-quarkus-cxf-rt-ws-security-usage-ws-security-via-ws-securitypolicy[WS-SecurityPolicy]
** New configuration options for xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-sts-client[STSClient]
* xref:reference/extensions/quarkus-cxf-services-sts.adoc[Security Token Service (STS) extension page] with a more detailed example

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/release-notes/3.9.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following parts of the documentation were improved:

* We published a bunch of xref:release-notes/index.adoc[release notes] for older {quarkus-cxf-project-name} versions 2.2.x through 2.7.x.
* Build time configuration options, such as `xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-codegen-wsdl2java-enabled[quarkus.cxf.codegen.wsdl2java.*]` were missing in on the `quarkus-cxf` reference page due to a bug in our tooling.
* We added xref:release-notes/index.adoc#version-table[Version table] to the release notes page.
* We added xref:release-notes/index.adoc[Version table] to the release notes page.
It shows which Quarkus CXF version is available in which Quarkus Platform version and which CXF version it depends on.

== Full changelog
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ where `\{service-path}` is derived from
* SEI’s class name in lower case

Given `quarkus.cxf.path = /ws`, the default effective `client-endpoint-url` of the `CalculatorService` would be
`http://localhost:8080/ws/org.jboss.eap.quickstarts.wscalculator.calculator.calculatorservice`.
`\http://localhost:8080/ws/org.jboss.eap.quickstarts.wscalculator.calculator.calculatorservice`.

If `quarkus.cxf.path` is not specified, the `client-endpoint-url` would be just
`http://localhost:8080/org.jboss.eap.quickstarts.wscalculator.calculator.calculatorservice`.
`\http://localhost:8080/org.jboss.eap.quickstarts.wscalculator.calculator.calculatorservice`.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class WeatherWebServiceImpl implements WeatherWebService {
----

After that, you would need to specify the root context for your CXF web services, as indicated
in the link:../reference/extensions/quarkus-cxf.html#quarkus-cxf_quarkus-cxf-path[configuration documentation] to split the REST (with RESTEasy for example)
in the xref:reference/extensions/quarkus-cxf.adoc#quarkus-cxf_quarkus-cxf-path[configuration documentation] to split the REST (with RESTEasy for example)
and SOAP routes based on their root context paths.

CXF's SOAP properties:
Expand Down
2 changes: 1 addition & 1 deletion docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

<dependency>
<groupId>io.quarkiverse.antora</groupId>
<artifactId>quarkus-antora-utils</artifactId>
<artifactId>quarkus-antorassured</artifactId>
<version>${quarkus-antora.version}</version>
<scope>test</scope>
</dependency>
Expand Down
23 changes: 14 additions & 9 deletions docs/src/test/java/io/quarkiverse/cxf/doc/it/AntoraTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.concurrent.TimeoutException;
import java.util.regex.Pattern;

import org.hamcrest.CoreMatchers;
import org.junit.jupiter.api.Test;

import io.quarkiverse.antora.test.AntoraTestUtils;
import io.quarkiverse.antorassured.AntorAssured;
import io.quarkus.test.junit.QuarkusTest;
import io.restassured.RestAssured;
import io.restassured.http.ContentType;
Expand All @@ -30,21 +31,25 @@ public void antoraSite() throws TimeoutException, IOException, InterruptedExcept
}

@Test
public void externalLinks() {
public void linksValid() {

Set<String> ignorables1 = Set.of(
"http://quarkus.io/training",
"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role",
"http://schemas.xmlsoap.org/ws/2005/02/sc/dk/p_sha1",
"http://www.w3.org/2009/xmlenc11#aes256-gcm");
final Set<String> ignorables = new LinkedHashSet<>(ignorables1);
final Set<String> ignorables = new LinkedHashSet<>();

final ZonedDateTime deadline = ZonedDateTime.parse("2025-01-28T23:59:59+01:00[Europe/Paris]");
if (ZonedDateTime.now(ZoneId.of("Europe/Paris")).isBefore(deadline)) {
ignorables.add("https://quarkus.io/blog/quarkus-3-18-0-released/");
ignorables.add("https://github.com/quarkiverse/quarkus-cxf/compare/3.17.2...3.18.0");
}

AntoraTestUtils.assertExternalLinksValid(err -> ignorables.contains(err.uri()));
AntorAssured
.links()
.excludeResolved("http://quarkus.io/training", "http://www.w3.org/2009/xmlenc11#aes256-gcm")
.excludeResolved(Pattern.compile("^\\Qhttp://localhost:808\\E[02].*"))
.excludeResolved(Pattern.compile("^\\Qhttp://schemas.xmlsoap.org/\\E.*"))
.excludeEditThisPage()
.validate()
.ignore(err -> ignorables.contains(err.uri().resolvedUri()))
.assertValid();

}
}
2 changes: 1 addition & 1 deletion extensions/services-sts/runtime/src/main/doc/usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ include::example$ws-trust/application.properties[tag=ws-trust-usage.adoc-client-
====
The properties for configuring the STS client are provided by the `io.quarkiverse.cxf:quarkus-cxf-rt-ws-security`
extension and documented on its
xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf-rt-ws-security_quarkus-cxf-client-clients-security-sts-client[reference page].
xref:reference/extensions/quarkus-cxf-rt-ws-security.adoc#quarkus-cxf_quarkus-cxf-client-client-name-security-sts-client[reference page].
====

Alternatively, the client can be set as a bean reference:
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
<quarkus.version>3.17.3</quarkus.version>
<cxf.version>4.0.6</cxf.version>
<quarkus-enforcer-rules.version>${quarkus.version}</quarkus-enforcer-rules.version>
<quarkus-antora.version>0.3.0</quarkus-antora.version>
<quarkus-antora.version>1.0.0</quarkus-antora.version>

<!-- Other compile dependency versions (keep sorted alphabetically) -->
<!-- Items annotated with @sync can be updated by running mvn cq:sync-versions -N -->
Expand Down
Loading