diff --git a/batch-processing/README.adoc b/batch-processing/README.adoc index bcbfe0e3b1..942dc92f48 100644 --- a/batch-processing/README.adoc +++ b/batch-processing/README.adoc @@ -695,45 +695,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -758,113 +731,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -889,7 +767,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -900,18 +778,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -926,8 +804,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/bmt/README.adoc b/bmt/README.adoc index e69a70fee9..a322963c65 100644 --- a/bmt/README.adoc +++ b/bmt/README.adoc @@ -627,45 +627,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -690,113 +663,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -821,7 +699,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -832,18 +710,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -858,8 +736,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/cmt/README.adoc b/cmt/README.adoc index b6a46ffe10..c564e1caab 100644 --- a/cmt/README.adoc +++ b/cmt/README.adoc @@ -641,45 +641,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -704,113 +677,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -835,7 +713,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -846,18 +724,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -872,8 +750,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/ee-security/README.adoc b/ee-security/README.adoc index fe69c1d924..8f6c1085f1 100644 --- a/ee-security/README.adoc +++ b/ee-security/README.adoc @@ -844,45 +844,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -907,113 +880,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1038,7 +916,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1049,18 +927,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1075,8 +953,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/ejb-remote/README.adoc b/ejb-remote/README.adoc index 9c2c4fc558..2f6f0d82c1 100644 --- a/ejb-remote/README.adoc +++ b/ejb-remote/README.adoc @@ -668,45 +668,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -731,113 +704,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -862,7 +740,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -873,18 +751,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -899,8 +777,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/ejb-security-context-propagation/README.adoc b/ejb-security-context-propagation/README.adoc index f9c73ebfac..fca601f9d9 100644 --- a/ejb-security-context-propagation/README.adoc +++ b/ejb-security-context-propagation/README.adoc @@ -799,7 +799,7 @@ You should see a message in the server log indicating that the archive deployed :leveloffset!: // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -894,28 +894,6 @@ ERROR [org.jboss.as.ejb3.invocation] (default task-57) WFLYEJB0034: EJB Invocati at java.lang.Thread.run(Thread.java:745) ---- -// Server Distribution Testing -:leveloffset: +2 - -[[run_the_integration_tests_with_server_distribution]] -= Run the Integration Tests -ifndef::integrationTestsDirectory[:integrationTestsDirectory: src/test/] -ifndef::extraStandardDistTestParams[:extraStandardDistTestParams: ] - -This quickstart includes integration tests, which are located under the `{integrationTestsDirectory}` directory. The integration tests verify that the quickstart runs correctly when deployed on the server. - -Follow these steps to run the integration tests. - -. Make sure {productName} server is started. -. Make sure the quickstart is deployed. -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn verify -Pintegration-testing {extraStandardDistTestParams} ----- - -:leveloffset!: // Undeploy the Quickstart :leveloffset: +1 @@ -1095,45 +1073,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1158,113 +1109,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- -// Server Provisioning Testing -:leveloffset: +1 +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server +Follow these steps to run the quickstart using the provisioned server. -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1289,7 +1145,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1300,18 +1156,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1326,8 +1182,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/ejb-security-programmatic-auth/README.adoc b/ejb-security-programmatic-auth/README.adoc index a5c2c58121..f27ec79f17 100644 --- a/ejb-security-programmatic-auth/README.adoc +++ b/ejb-security-programmatic-auth/README.adoc @@ -724,7 +724,7 @@ Principal has admin permission: true As expected, the `quickstart` user is able to call the methods available for `guest`, but does not have the `admin` permission to call administrative methods on the remote EJB. The `quickstartAdmin` on the other hand has permissions to call both methods. // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -889,28 +889,6 @@ When you have completed testing the quickstart, you can restore the original ser . If it is running, stop the {productName} server. . Replace the `__{jbossHomeName}__/{configFileName}` file with the backup copy of the file. -:leveloffset!: -// Run the Quickstart in Red Hat CodeReady Studio or Eclipse -:leveloffset: +1 - -[[run_the_quickstart_in_redhat_codeready_studio_or_eclipse]] -= Run the Quickstart in {JBDSProductName} or Eclipse -//****************************************************************************** -// Include this template to provide instructions to run the quickstart -// in Red Hat CodeReady Studio. -// -// If the quickstart is not supported, create the `jbds-not-supported` attribute. -//****************************************************************************** -ifdef::jbds-not-supported[] -This quickstart is not supported in {JBDSProductName}. -endif::jbds-not-supported[] - -ifndef::jbds-not-supported[] -You can also start the server and deploy the quickstarts, or run any tests in {JBDSProductName} or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use {JBDSProductName} or Eclipse to Run the Quickstarts]. -endif::jbds-not-supported[] - -// Add additional instructions specific to running this quickstart in an IDE here. - :leveloffset!: // Additional Red Hat CodeReady Studio instructions @@ -938,34 +916,6 @@ Principal has admin permission: true * Make sure you xref:restore_the_server_configuration[restore the {productName} standalone server configuration] when you have completed testing this quickstart. -// Debug the Application -:leveloffset: +1 - -[[debug_the_application]] -= Debug the Application -//****************************************************************************** -// Include this template to provide debugging information. -//****************************************************************************** - -If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it. - ----- -$ mvn dependency:sources ----- - -//// -TODO: I need to investigate whether the following version can be used across all quickstarts. - -If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them. - -[source,options="nowrap"] ----- -$ mvn dependency:sources -$ mvn dependency:resolve -Dclassifier=javadoc ----- -//// - -:leveloffset!: // Build and run sections for other environments/builds ifndef::ProductRelease,EAPXPRelease[] :leveloffset: +1 @@ -990,45 +940,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1053,113 +976,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] +Follow these steps to run the quickstart using the provisioned server. -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1184,7 +1012,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1195,18 +1023,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1221,8 +1049,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/ejb-throws-exception/README.adoc b/ejb-throws-exception/README.adoc index 6f2567e9ac..af2e0d4656 100644 --- a/ejb-throws-exception/README.adoc +++ b/ejb-throws-exception/README.adoc @@ -569,7 +569,6 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: - // Undeploy the Quickstart :leveloffset: +1 @@ -615,45 +614,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -678,113 +650,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -809,7 +686,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -820,18 +697,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -846,8 +723,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/ejb-timer/README.adoc b/ejb-timer/README.adoc index b1bff84815..db688e111d 100644 --- a/ejb-timer/README.adoc +++ b/ejb-timer/README.adoc @@ -550,7 +550,7 @@ INFO [stdout] (EJB default - 2) Timeout received for TimeoutExample[-1065503193 ---- // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -571,7 +571,6 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: - // Undeploy the Quickstart :leveloffset: +1 @@ -618,45 +617,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -681,113 +653,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. +Follow these steps to run the quickstart using the provisioned server. -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -812,7 +689,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -823,18 +700,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -849,8 +726,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/ejb-txn-remote-call/README.adoc b/ejb-txn-remote-call/README.adoc index a70eaca477..5b49edd931 100644 --- a/ejb-txn-remote-call/README.adoc +++ b/ejb-txn-remote-call/README.adoc @@ -865,17 +865,17 @@ Instead of using a standard {productName} server distribution, the three {produc [source,sh,subs="+quotes,attributes+",options="nowrap"] ---- cd ${PATH_TO_QUICKSTART_DIR}/ejb-txn-remote-call/client; -mvn clean package -Pprovisioned-server \ +mvn clean package \ -DremoteServerUsername="quickstartUser" -DremoteServerPassword="quickstartPwd1!" \ -DpostgresqlUsername="test" -DpostgresqlPassword="test" ---- [source,sh,subs="+quotes,attributes+",options="nowrap"] ---- cd ${PATH_TO_QUICKSTART_DIR}/ejb-txn-remote-call/server; -mvn clean package -Pprovisioned-server \ +mvn clean package \ -Dwildfly.provisioning.dir=server2 -Djboss-as.home=target/server2 \ -DpostgresqlUsername="test" -DpostgresqlPassword="test"; -mvn package -Pprovisioned-server \ +mvn package \ -Dwildfly.provisioning.dir=server3 -Djboss-as.home=target/server3 \ -DpostgresqlUsername="test" -DpostgresqlPassword="test" ---- @@ -918,7 +918,7 @@ podman run -p 5432:5432 --rm -ePOSTGRES_DB=test -ePOSTGRES_USER=test -ePOSTGRES [source,subs="attributes+",options="nowrap"] ---- cd ${PATH_TO_QUICKSTART_DIR}/ejb-txn-remote-call/client; -mvn wildfly:start -Djboss-as.home=target/server \ +mvn wildfly:start \ -Dwildfly.javaOpts="-Djboss.tx.node.id=server1 -Djboss.node.name=server1" ---- + @@ -995,8 +995,6 @@ might result in no-ACID transactions. === Prerequisites -Unresolved directive in README-source.adoc - include::../shared-doc/cd-create-project.adoc[leveloffset=+3] - [#_install_operator] ==== Install {productName}'s Operator diff --git a/helloworld-jms/README.adoc b/helloworld-jms/README.adoc index c1818c9667..5ecd893ea8 100644 --- a/helloworld-jms/README.adoc +++ b/helloworld-jms/README.adoc @@ -719,45 +719,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -782,113 +755,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -[source,shell] ----- -wildfly-glow show-add-ons ----- +Follow these steps to run the quickstart using the provisioned server. -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -913,7 +791,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -924,18 +802,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -950,8 +828,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/helloworld-mdb/README.adoc b/helloworld-mdb/README.adoc index 0e04a0cab5..c7ebe34cd1 100644 --- a/helloworld-mdb/README.adoc +++ b/helloworld-mdb/README.adoc @@ -588,7 +588,6 @@ $ mvn wildfly:undeploy ---- :leveloffset!: -endif::[] // Build and run sections for other environments/builds ifndef::ProductRelease,EAPXPRelease[] @@ -614,45 +613,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -677,113 +649,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -808,7 +685,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -819,18 +696,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -845,8 +722,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/helloworld-mutual-ssl-secured/README.adoc b/helloworld-mutual-ssl-secured/README.adoc index de2fdc3a2f..4061b3e81c 100644 --- a/helloworld-mutual-ssl-secured/README.adoc +++ b/helloworld-mutual-ssl-secured/README.adoc @@ -816,7 +816,7 @@ ynfnMaOxI67FC2QzhfzERyKqHj47WuwN0xWbS/1gBypS2nUwvItyxaEQG2X5uQY8j8QoY9wcMzIIkP2M // Server Distribution Testing :extraStandardDistTestParams: -Dserver.dir=__{jbossHomeName}__ -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -1051,45 +1051,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1114,113 +1087,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 +Follow these steps to run the quickstart using the provisioned server. -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1245,7 +1123,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1256,18 +1134,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1282,8 +1160,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/helloworld-mutual-ssl/README.adoc b/helloworld-mutual-ssl/README.adoc index aa957a6354..9a1955f3c7 100644 --- a/helloworld-mutual-ssl/README.adoc +++ b/helloworld-mutual-ssl/README.adoc @@ -718,7 +718,7 @@ aEWK4zhPVFynfnMaOxI67FC2QzhfzERyKqHj47WuwN0xWbS/1gBypS2nUwvItyxaEQG2X5uQY8j8QoY9 // Server Distribution Testing :extraStandardDistTestParams: -Dserver.dir=__{jbossHomeName}__ -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -950,45 +950,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1013,113 +986,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 +Follow these steps to run the quickstart using the provisioned server. -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1144,7 +1022,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1155,18 +1033,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1181,8 +1059,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/helloworld-rs/README.adoc b/helloworld-rs/README.adoc index 6fe9f9f705..ccdedf6d79 100644 --- a/helloworld-rs/README.adoc +++ b/helloworld-rs/README.adoc @@ -569,45 +569,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -632,113 +605,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -763,7 +641,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -774,18 +652,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -800,8 +678,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/helloworld-singleton/README.adoc b/helloworld-singleton/README.adoc index 50b0ce7265..a7a523ba2f 100644 --- a/helloworld-singleton/README.adoc +++ b/helloworld-singleton/README.adoc @@ -576,45 +576,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -639,113 +612,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -770,7 +648,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -781,18 +659,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -807,8 +685,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/helloworld-ws/README.adoc b/helloworld-ws/README.adoc index 73d4acba3a..8e3036cfad 100644 --- a/helloworld-ws/README.adoc +++ b/helloworld-ws/README.adoc @@ -516,6 +516,28 @@ JBWS024061: Adding service endpoint metadata: id=org.jboss.as.quickstarts.wshell You can verify that the Web Service is running and deployed correctly by accessing the following URL: http://localhost:8080/HelloWorldService?wsdl. This URL will display the deployed WSDL endpoint for the Web Service. +// Server Distribution Testing +:leveloffset: +2 + +[[run_the_integration_tests_with_server_distribution]] += Run the Integration Tests +ifndef::integrationTestsDirectory[:integrationTestsDirectory: src/test/] +ifndef::extraStandardDistTestParams[:extraStandardDistTestParams: ] + +This quickstart includes integration tests, which are located under the `{integrationTestsDirectory}` directory. The integration tests verify that the quickstart runs correctly when deployed on the server. + +Follow these steps to run the integration tests. + +. Make sure {productName} server is started. +. Make sure the quickstart is deployed. +. Type the following command to run the `verify` goal with the `integration-testing` profile activated. ++ +[source,subs="attributes+",options="nowrap"] +---- +$ mvn verify -Pintegration-testing {extraStandardDistTestParams} +---- + +:leveloffset!: // Undeploy the Quickstart :leveloffset: +2 @@ -562,45 +584,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -625,113 +620,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] +Follow these steps to run the quickstart using the provisioned server. -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -756,7 +656,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -767,18 +667,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -793,8 +693,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/helloworld/README.adoc b/helloworld/README.adoc index 9ed8f9831a..a29326b5e4 100644 --- a/helloworld/README.adoc +++ b/helloworld/README.adoc @@ -569,45 +569,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -632,113 +605,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -763,7 +641,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -774,18 +652,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -800,8 +678,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/hibernate/README.adoc b/hibernate/README.adoc index 3cfac3c1f9..091325a9c9 100644 --- a/hibernate/README.adoc +++ b/hibernate/README.adoc @@ -712,6 +712,7 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: + // Undeploy the Quickstart :leveloffset: +2 @@ -884,45 +885,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -947,113 +921,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1078,7 +957,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1089,18 +968,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1115,8 +994,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/http-custom-mechanism/README.adoc b/http-custom-mechanism/README.adoc index 4fddbec5b8..acd3f03b71 100644 --- a/http-custom-mechanism/README.adoc +++ b/http-custom-mechanism/README.adoc @@ -804,6 +804,28 @@ You should see the HTTP result `HTTP/1.1 200 OK`, along with some header informa ---- +// Server Distribution Testing +:leveloffset: +2 + +[[run_the_integration_tests_with_server_distribution]] += Run the Integration Tests +ifndef::integrationTestsDirectory[:integrationTestsDirectory: src/test/] +ifndef::extraStandardDistTestParams[:extraStandardDistTestParams: ] + +This quickstart includes integration tests, which are located under the `{integrationTestsDirectory}` directory. The integration tests verify that the quickstart runs correctly when deployed on the server. + +Follow these steps to run the integration tests. + +. Make sure {productName} server is started. +. Make sure the quickstart is deployed. +. Type the following command to run the `verify` goal with the `integration-testing` profile activated. ++ +[source,subs="attributes+",options="nowrap"] +---- +$ mvn verify -Pintegration-testing {extraStandardDistTestParams} +---- + +:leveloffset!: // Undeploy the Quickstart :leveloffset: +2 @@ -1019,45 +1041,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1082,113 +1077,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1213,7 +1113,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1224,18 +1124,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1250,8 +1150,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/jaxrs-client/README.adoc b/jaxrs-client/README.adoc index a0d055e2f7..cb6642692b 100644 --- a/jaxrs-client/README.adoc +++ b/jaxrs-client/README.adoc @@ -521,27 +521,6 @@ Follow these steps to run the integration tests. $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- -:leveloffset!: -// Undeploy the Quickstart -:leveloffset: +2 - -[[undeploy_the_quickstart]] -= Undeploy the Quickstart - -//******************************************************************************* -// Include this template if your quickstart does a normal undeployment of an archive. -//******************************************************************************* -When you are finished testing the quickstart, follow these steps to undeploy the archive. - -. Make sure {productName} server is started. -. Open a terminal and navigate to the root directory of this quickstart. -. Type this command to undeploy the archive: -+ -[source,options="nowrap"] ----- -$ mvn wildfly:undeploy ----- - :leveloffset!: === Investigate the Console Output @@ -567,6 +546,28 @@ When you run the integration tests, Maven prints summary of the performed tests [INFO] Tests run: 20, Failures: 0, Errors: 0, Skipped: 0 ---- +// Undeploy the Quickstart +:leveloffset: +2 + +[[undeploy_the_quickstart]] += Undeploy the Quickstart + +//******************************************************************************* +// Include this template if your quickstart does a normal undeployment of an archive. +//******************************************************************************* +When you are finished testing the quickstart, follow these steps to undeploy the archive. + +. Make sure {productName} server is started. +. Open a terminal and navigate to the root directory of this quickstart. +. Type this command to undeploy the archive: ++ +[source,options="nowrap"] +---- +$ mvn wildfly:undeploy +---- + +:leveloffset!: + // Build and run sections for other environments/builds ifndef::ProductRelease,EAPXPRelease[] :leveloffset: +1 @@ -591,45 +592,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -654,113 +628,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 +Follow these steps to run the quickstart using the provisioned server. -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -785,7 +664,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -796,18 +675,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -822,8 +701,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/jaxrs-jwt/README.adoc b/jaxrs-jwt/README.adoc index 1ba15af658..7a25bf2746 100644 --- a/jaxrs-jwt/README.adoc +++ b/jaxrs-jwt/README.adoc @@ -673,7 +673,7 @@ You should see a message in the server log indicating that the archive deployed The `JwtAuthIT` test shows how a client can authenticate with the server. // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -839,34 +839,6 @@ When you have completed testing the quickstart, you can restore the original ser . If it is running, stop the {productName} server. . Replace the `__{jbossHomeName}__/{configFileName}` file with the backup copy of the file. -:leveloffset!: -// Debug the Application -:leveloffset: +1 - -[[debug_the_application]] -= Debug the Application -//****************************************************************************** -// Include this template to provide debugging information. -//****************************************************************************** - -If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it. - ----- -$ mvn dependency:sources ----- - -//// -TODO: I need to investigate whether the following version can be used across all quickstarts. - -If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them. - -[source,options="nowrap"] ----- -$ mvn dependency:sources -$ mvn dependency:resolve -Dclassifier=javadoc ----- -//// - :leveloffset!: ifndef::ProductRelease,EAPXPRelease[] @@ -892,45 +864,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -955,113 +900,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. +Follow these steps to run the quickstart using the provisioned server. -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1086,7 +936,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1097,18 +947,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1123,8 +973,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/jaxws-ejb/README.adoc b/jaxws-ejb/README.adoc index c170835bb4..ba4b820740 100644 --- a/jaxws-ejb/README.adoc +++ b/jaxws-ejb/README.adoc @@ -574,45 +574,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -637,113 +610,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -768,7 +646,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -779,18 +657,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -805,8 +683,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/jaxws-retail/README.adoc b/jaxws-retail/README.adoc index c960c3bb4c..976caee0c2 100644 --- a/jaxws-retail/README.adoc +++ b/jaxws-retail/README.adoc @@ -395,7 +395,6 @@ $ __{jbossHomeName}__/bin/standalone.sh {serverArguments} -b 0.0.0.0 endif::[] :leveloffset!: - // Build and Deploy the Quickstart :leveloffset: +1 @@ -498,13 +497,11 @@ You should see a message in the server log indicating that the archive deployed :leveloffset!: - == Access the Application - You can check that the Web Service is running and deployed correctly by accessing the following URL: http://localhost:8080/{artifactId}/ProfileMgmtService/ProfileMgmt?wsdl. This URL will display the deployed WSDL endpoint for the Web Service. // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -526,7 +523,7 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} :leveloffset!: // Undeploy the Quickstart -:leveloffset: +2 +:leveloffset: +1 [[undeploy_the_quickstart]] = Undeploy the Quickstart @@ -571,45 +568,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -634,113 +604,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 +Follow these steps to run the quickstart using the provisioned server. -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -765,7 +640,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -776,18 +651,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -802,8 +677,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/jsonp/README.adoc b/jsonp/README.adoc index 50b77dd8e0..ab808877b0 100644 --- a/jsonp/README.adoc +++ b/jsonp/README.adoc @@ -527,45 +527,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -590,113 +563,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -721,7 +599,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -732,18 +610,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -758,8 +636,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/jta-crash-rec/README.adoc b/jta-crash-rec/README.adoc index fc4e58d6de..7ccddd2216 100644 --- a/jta-crash-rec/README.adoc +++ b/jta-crash-rec/README.adoc @@ -678,6 +678,28 @@ WFLYJCA0091: -ds.xml file deployments are deprecated. Support may be removed in HHH000431: Unable to determine H2 database version, certain features may not work ---- +// Server Distribution Testing +:leveloffset: +1 + +[[run_the_integration_tests_with_server_distribution]] += Run the Integration Tests +ifndef::integrationTestsDirectory[:integrationTestsDirectory: src/test/] +ifndef::extraStandardDistTestParams[:extraStandardDistTestParams: ] + +This quickstart includes integration tests, which are located under the `{integrationTestsDirectory}` directory. The integration tests verify that the quickstart runs correctly when deployed on the server. + +Follow these steps to run the integration tests. + +. Make sure {productName} server is started. +. Make sure the quickstart is deployed. +. Type the following command to run the `verify` goal with the `integration-testing` profile activated. ++ +[source,subs="attributes+",options="nowrap"] +---- +$ mvn verify -Pintegration-testing {extraStandardDistTestParams} +---- + +:leveloffset!: // Undeploy the Quickstart :leveloffset: +1 diff --git a/kitchensink/README.adoc b/kitchensink/README.adoc index a82364028f..fdb6cb44dd 100644 --- a/kitchensink/README.adoc +++ b/kitchensink/README.adoc @@ -702,45 +702,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -765,113 +738,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -896,7 +774,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -907,18 +785,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -933,8 +811,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/logging/README.adoc b/logging/README.adoc index ce3c2107e0..9d653edeb7 100644 --- a/logging/README.adoc +++ b/logging/README.adoc @@ -875,45 +875,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -938,113 +911,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1069,7 +947,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1080,18 +958,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1106,8 +984,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/mail/README.adoc b/mail/README.adoc index a82a46913e..7cb1a2f9e5 100644 --- a/mail/README.adoc +++ b/mail/README.adoc @@ -703,7 +703,7 @@ NOTE: If you see `Error processing request` in the browser when you access the a NOTE: If you are using the Mail server shipped with this Quickstart and see `Error sending the Email. Invalid Addresses` in the browser when you attempt to send email, make sure you are sending your email to an existing account configured in the Mail Server since by default Apache James demo image is shipped with relay disabled. By default, Apache James demo image has the following accounts configured: user01@james.local, user02@james.local and user03@james.local. // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -724,7 +724,6 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: - // Undeploy the Quickstart :leveloffset: +1 @@ -953,45 +952,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1016,113 +988,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] +Follow these steps to run the quickstart using the provisioned server. -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1147,7 +1024,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1158,18 +1035,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1184,8 +1061,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/messaging-clustering-singleton/README.adoc b/messaging-clustering-singleton/README.adoc index 2c04971fa7..b9e61239d3 100644 --- a/messaging-clustering-singleton/README.adoc +++ b/messaging-clustering-singleton/README.adoc @@ -878,30 +878,6 @@ $ __{jbossHomeName}_2__/bin/jboss-cli.sh --connect controller=localhost:10090 -- NOTE: For Windows, use the `__{jbossHomeName}_1__\bin\jboss-cli.bat` and `__{jbossHomeName}_2__\bin\jboss-cli.bat` scripts. - -// Server Distribution Testing -:leveloffset: +2 - -[[run_the_integration_tests_with_server_distribution]] -= Run the Integration Tests -ifndef::integrationTestsDirectory[:integrationTestsDirectory: src/test/] -ifndef::extraStandardDistTestParams[:extraStandardDistTestParams: ] - -This quickstart includes integration tests, which are located under the `{integrationTestsDirectory}` directory. The integration tests verify that the quickstart runs correctly when deployed on the server. - -Follow these steps to run the integration tests. - -. Make sure {productName} server is started. -. Make sure the quickstart is deployed. -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn verify -Pintegration-testing {extraStandardDistTestParams} ----- - -:leveloffset!: - ==== Run the Integration Tests in a Managed Domain The integration tests may also be run with the domain server by typing the following command. diff --git a/micrometer/README.adoc b/micrometer/README.adoc index ed96d2d1b4..ea3e0bb3e1 100644 --- a/micrometer/README.adoc +++ b/micrometer/README.adoc @@ -926,45 +926,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -989,113 +962,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- -// Server Provisioning Testing -:leveloffset: +1 +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server +Follow these steps to run the quickstart using the provisioned server. -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1120,7 +998,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1131,18 +1009,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1157,86 +1035,13 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] // Bootable JAR :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -1301,40 +1106,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] -Follow these steps to run the integration tests. +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. + +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: + +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure -. Make sure the bootable jar is provisioned. +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // OpenShift :leveloffset: +1 diff --git a/microprofile-config/README.adoc b/microprofile-config/README.adoc index 08da1b6009..98913248f7 100644 --- a/microprofile-config/README.adoc +++ b/microprofile-config/README.adoc @@ -514,7 +514,7 @@ You should see a message in the server log indicating that the archive deployed :leveloffset!: // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -1368,78 +1368,7 @@ converter. You will see the configured value which is taken from our created :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -1504,40 +1433,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] + +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. -Follow these steps to run the integration tests. +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: -. Make sure the bootable jar is provisioned. +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure + +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // Openshift diff --git a/microprofile-fault-tolerance/README.adoc b/microprofile-fault-tolerance/README.adoc index 1a5ecbffc7..1cac7f0e3a 100644 --- a/microprofile-fault-tolerance/README.adoc +++ b/microprofile-fault-tolerance/README.adoc @@ -1164,7 +1164,6 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: - // Undeploy the Quickstart :leveloffset: +2 @@ -1191,78 +1190,7 @@ $ mvn wildfly:undeploy :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -1327,40 +1255,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] + +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. -Follow these steps to run the integration tests. +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: -. Make sure the bootable jar is provisioned. +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure + +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // OpenShift diff --git a/microprofile-health/README.adoc b/microprofile-health/README.adoc index c56112a9f7..87c37fabb4 100644 --- a/microprofile-health/README.adoc +++ b/microprofile-health/README.adoc @@ -548,33 +548,8 @@ declared health check procedures. NOTE: Similarly, you can access `http://localhost:9990/health/ready`, `http://localhost:9990/health/started`, and `http://localhost:9990/health` -Congratulations! You successfully deployed and run this quickstart. If you wish to -create the application step by step you can follow the subsequent sections. - -// Undeploy the Quickstart -:leveloffset: +1 - -[[undeploy_the_quickstart]] -= Undeploy the Quickstart - -//******************************************************************************* -// Include this template if your quickstart does a normal undeployment of an archive. -//******************************************************************************* -When you are finished testing the quickstart, follow these steps to undeploy the archive. - -. Make sure {productName} server is started. -. Open a terminal and navigate to the root directory of this quickstart. -. Type this command to undeploy the archive: -+ -[source,options="nowrap"] ----- -$ mvn wildfly:undeploy ----- - -:leveloffset!: - // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -595,27 +570,25 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: - -// Run the Quickstart in Red Hat CodeReady Studio or Eclipse +// Undeploy the Quickstart :leveloffset: +1 -[[run_the_quickstart_in_redhat_codeready_studio_or_eclipse]] -= Run the Quickstart in {JBDSProductName} or Eclipse -//****************************************************************************** -// Include this template to provide instructions to run the quickstart -// in Red Hat CodeReady Studio. -// -// If the quickstart is not supported, create the `jbds-not-supported` attribute. -//****************************************************************************** -ifdef::jbds-not-supported[] -This quickstart is not supported in {JBDSProductName}. -endif::jbds-not-supported[] +[[undeploy_the_quickstart]] += Undeploy the Quickstart -ifndef::jbds-not-supported[] -You can also start the server and deploy the quickstarts, or run any tests in {JBDSProductName} or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use {JBDSProductName} or Eclipse to Run the Quickstarts]. -endif::jbds-not-supported[] +//******************************************************************************* +// Include this template if your quickstart does a normal undeployment of an archive. +//******************************************************************************* +When you are finished testing the quickstart, follow these steps to undeploy the archive. -// Add additional instructions specific to running this quickstart in an IDE here. +. Make sure {productName} server is started. +. Open a terminal and navigate to the root directory of this quickstart. +. Type this command to undeploy the archive: ++ +[source,options="nowrap"] +---- +$ mvn wildfly:undeploy +---- :leveloffset!: @@ -1048,78 +1021,7 @@ error along with the health check response. :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -1184,40 +1086,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] -Follow these steps to run the integration tests. +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. + +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: -. Make sure the bootable jar is provisioned. +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure + +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // OpenShift diff --git a/microprofile-jwt/README.adoc b/microprofile-jwt/README.adoc index b99e439038..016ee115d2 100644 --- a/microprofile-jwt/README.adoc +++ b/microprofile-jwt/README.adoc @@ -376,25 +376,110 @@ endif::[] :leveloffset!: -[[configure_the_server]] -== Configure the Server +// Build and Deploy the Quickstart +:leveloffset: +1 + +[[build_and_deploy_the_quickstart]] += Build and Deploy the Quickstart +//****************************************************************************** +// Include this template if your quickstart does a normal deployment of a archive. +// +// * Define the `archiveType` variable in the quickstart README file. +// Supported values: +// :archiveType: ear +// :archiveType: war +// :archiveType: jar +// +// * To override the archive name, which defaults to the {artifactId), +// define the `archiveName` variable, for example: +// :archiveName: {artifactId}-service +// +// * To override the archive output directory, +// define the `archiveDir` variable, for example: +// :archiveDir: ear/target +// +// * To override the Maven command, define the `mavenCommand` variable, +// for example: +// :mavenCommand: clean install wildfly:deploy +//****************************************************************************** -One of the benefits of using MicroProfile JWT is that the configuration is contained entirely within the deployment, -for this reason no manual configuration of the server is required to execute the quickstart. +// The archive name defaults to the artifactId if not overridden +ifndef::archiveName[] +:archiveName: {artifactId} +endif::archiveName[] -== Solution +// The archive type defaults to war if not overridden +ifndef::archiveType[] +:archiveType: war +endif::archiveType[] -We recommend that you follow the instructions in the next sections and create the application step by step as this will -provide a better foundation for creating your own MP-JWT secured deployment, however if you want to jump straight to -executing the quickstarts the steps here can be followed to execute the included code. +// Define the archive file name as the concatenation of "archiveName" + "." + "archiveType+ +:archiveFileName: {archiveName}.{archiveType} -The quickstart can be deployed to the running application server using the following command: - +// If they have not defined the target archive directory, make it the default for the archive type. +ifndef::archiveDir[] -[source] +ifeval::["{archiveType}"=="ear"] +:archiveDir: {artifactId}/ear/target +endif::[] + +ifeval::["{archiveType}"=="war"] +:archiveDir: {artifactId}/target +endif::[] + +ifeval::["{archiveType}"=="jar"] +:archiveDir: {artifactId}/target +endif::[] + +endif::archiveDir[] + +ifndef::mavenCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenCommand: clean install +endif::[] + +ifeval::["{archiveType}"=="war"] +:mavenCommand: clean package +endif::[] + +ifeval::["{archiveType}"=="jar"] +:mavenCommand: clean install +endif::[] + +endif::mavenCommand[] + +. Make sure {productName} server is started. +. Open a terminal and navigate to the root directory of this quickstart. +ifdef::reactive-messaging[] +. Run this command to enable the MicroProfile Reactive Messaging functionality on the server ++ +[source,subs="attributes+",options="nowrap"] +---- +$ __{jbossHomeName}__/bin/jboss-cli.sh --connect --file=enable-reactive-messaging.cli ---- -mvn package wildfly:deploy +endif::reactive-messaging[] +. Type the following command to build the quickstart. ++ +[source,subs="attributes+",options="nowrap"] +---- +$ mvn {mavenCommand} ---- +. Type the following command to deploy the quickstart. ++ +[source,subs="attributes+",options="nowrap"] +---- +$ mvn wildfly:deploy +---- + +This deploys the `{archiveDir}/{archiveFileName}` to the running instance of the server. + +You should see a message in the server log indicating that the archive deployed successfully. + +:leveloffset!: + +== Using the application + An unauthenticated call can be made to one of the deployed endpoints using the following command: - [source] @@ -459,13 +544,8 @@ $ curl -H "Authorization: Bearer ey..XPA" http://localhost:8080/microprofile-jwt 7 months and 19 days until your next birthday. ---- -This section has been a fast run through of the commands required to deploy the quickstart, generate JWT tokens and call the various endpoints, for further information as to how this was achieved -please read through the next section where the process to generate this quickstart from scratch is described step by step. - -It is also possible to run each of these calls from the test case included in the quickstart. - // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -485,6 +565,27 @@ Follow these steps to run the integration tests. $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- +:leveloffset!: +// Undeploy the Quickstart +:leveloffset: +1 + +[[undeploy_the_quickstart]] += Undeploy the Quickstart + +//******************************************************************************* +// Include this template if your quickstart does a normal undeployment of an archive. +//******************************************************************************* +When you are finished testing the quickstart, follow these steps to undeploy the archive. + +. Make sure {productName} server is started. +. Open a terminal and navigate to the root directory of this quickstart. +. Type this command to undeploy the archive: ++ +[source,options="nowrap"] +---- +$ mvn wildfly:undeploy +---- + :leveloffset!: == Starting from Scratch @@ -557,7 +658,7 @@ Before the dependencies are defined add the following boms. ---- -By using boms the majority of dependencies used within this quickstart align with the version uses by the application server. +By using BOMs the majority of dependencies used within this quickstart align with the version uses by the application server. The following dependencies can now be added to the project. @@ -1129,78 +1230,7 @@ $ curl -H "Authorization: Bearer ey..59g" http://localhost:8080/microprofile-jwt :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -1265,40 +1295,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] + +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. -Follow these steps to run the integration tests. +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: + +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- -. Make sure the bootable jar is provisioned. +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure + +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // OpenShift diff --git a/microprofile-lra/README.adoc b/microprofile-lra/README.adoc index 638a8b8b22..af6183f0e7 100644 --- a/microprofile-lra/README.adoc +++ b/microprofile-lra/README.adoc @@ -683,7 +683,7 @@ You should see a message in the server log indicating that the archive deployed :leveloffset!: // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -857,78 +857,7 @@ When you have completed testing the quickstart, you can restore the original ser :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -993,40 +922,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] + +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. -Follow these steps to run the integration tests. +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: -. Make sure the bootable jar is provisioned. +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure + +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // OpenShift diff --git a/microprofile-openapi/README.adoc b/microprofile-openapi/README.adoc index 1be0657fc2..8d8b53dc49 100644 --- a/microprofile-openapi/README.adoc +++ b/microprofile-openapi/README.adoc @@ -598,7 +598,7 @@ $ echo "mp.openapi.scan.disable=true" > src/main/webapp/META-INF/application.pro The OpenAPI document model will now be built from the static content rather than annotation processing. // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -619,7 +619,7 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: - +// Undeploy the Quickstart :leveloffset: +1 [[undeploy_the_quickstart]] @@ -645,78 +645,7 @@ $ mvn wildfly:undeploy :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -781,40 +710,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] + +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. -Follow these steps to run the integration tests. +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: -. Make sure the bootable jar is provisioned. +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure + +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // OpenShift diff --git a/microprofile-reactive-messaging-kafka/README.adoc b/microprofile-reactive-messaging-kafka/README.adoc index ba604b2a3f..4aee9d8edd 100644 --- a/microprofile-reactive-messaging-kafka/README.adoc +++ b/microprofile-reactive-messaging-kafka/README.adoc @@ -516,31 +516,8 @@ You should see a message in the server log indicating that the archive deployed :leveloffset!: - -// Undeploy the Quickstart -:leveloffset: +1 - -[[undeploy_the_quickstart]] -= Undeploy the Quickstart - -//******************************************************************************* -// Include this template if your quickstart does a normal undeployment of an archive. -//******************************************************************************* -When you are finished testing the quickstart, follow these steps to undeploy the archive. - -. Make sure {productName} server is started. -. Open a terminal and navigate to the root directory of this quickstart. -. Type this command to undeploy the archive: -+ -[source,options="nowrap"] ----- -$ mvn wildfly:undeploy ----- - -:leveloffset!: - // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -562,26 +539,25 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} :leveloffset!: -// Run the Quickstart in Red Hat CodeReady Studio or Eclipse +// Undeploy the Quickstart :leveloffset: +1 -[[run_the_quickstart_in_redhat_codeready_studio_or_eclipse]] -= Run the Quickstart in {JBDSProductName} or Eclipse -//****************************************************************************** -// Include this template to provide instructions to run the quickstart -// in Red Hat CodeReady Studio. -// -// If the quickstart is not supported, create the `jbds-not-supported` attribute. -//****************************************************************************** -ifdef::jbds-not-supported[] -This quickstart is not supported in {JBDSProductName}. -endif::jbds-not-supported[] +[[undeploy_the_quickstart]] += Undeploy the Quickstart -ifndef::jbds-not-supported[] -You can also start the server and deploy the quickstarts, or run any tests in {JBDSProductName} or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use {JBDSProductName} or Eclipse to Run the Quickstarts]. -endif::jbds-not-supported[] +//******************************************************************************* +// Include this template if your quickstart does a normal undeployment of an archive. +//******************************************************************************* +When you are finished testing the quickstart, follow these steps to undeploy the archive. -// Add additional instructions specific to running this quickstart in an IDE here. +. Make sure {productName} server is started. +. Open a terminal and navigate to the root directory of this quickstart. +. Type this command to undeploy the archive: ++ +[source,options="nowrap"] +---- +$ mvn wildfly:undeploy +---- :leveloffset!: @@ -1560,78 +1536,7 @@ data: three :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -1696,40 +1601,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] -Follow these steps to run the integration tests. +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. -. Make sure the bootable jar is provisioned. +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: + +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure + +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: [NOTE] diff --git a/microprofile-rest-client/README.adoc b/microprofile-rest-client/README.adoc index 217b53dc22..f395115ba0 100644 --- a/microprofile-rest-client/README.adoc +++ b/microprofile-rest-client/README.adoc @@ -651,7 +651,6 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: - // Undeploy the Quickstart :leveloffset: +1 @@ -678,78 +677,7 @@ $ mvn wildfly:undeploy :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -814,40 +742,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] + +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. -Follow these steps to run the integration tests. +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: -. Make sure the bootable jar is provisioned. +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure + +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // OpenShift :leveloffset: +1 diff --git a/numberguess/README.adoc b/numberguess/README.adoc index af386324c8..ca24e20ab1 100644 --- a/numberguess/README.adoc +++ b/numberguess/README.adoc @@ -570,45 +570,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -633,113 +606,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -764,7 +642,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -775,18 +653,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -801,8 +679,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/opentelemetry-tracing/README.adoc b/opentelemetry-tracing/README.adoc index 172b1508ea..8b86e9dd15 100644 --- a/opentelemetry-tracing/README.adoc +++ b/opentelemetry-tracing/README.adoc @@ -766,7 +766,7 @@ otel-collector_1 | {"kind": "exporter", "data_type": "traces", "name": "log ----- // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -946,45 +946,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1009,113 +982,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1140,7 +1018,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1151,18 +1029,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1177,86 +1055,13 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] // Bootable JAR :leveloffset: +1 [[build_and_run_the_quickstart_with_bootable_jar]] -= Building and running the quickstart application in a bootable JAR - -You can use the WildFly JAR Maven plug-in to build a {productName} bootable JAR to run this quickstart. - -The quickstart `pom.xml` file contains a Maven profile named *bootable-jar* which configures the bootable JAR building: - -[source,xml,subs="attributes+"] ----- - - bootable-jar - - - - org.wildfly.plugins - wildfly-maven-plugin - - - ${version.server} - - true - ... - - - - - package - - - - - ... - - - ----- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -.Procedure - -. Build the quickstart bootable JAR with the following command: -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn clean package -Pbootable-jar ----- - -. Run the quickstart application contained in the bootable JAR: -+ -[source,subs="attributes+",options="nowrap"] ----- -ifdef::uses-jaeger[] -$ JAEGER_REPORTER_LOG_SPANS=true JAEGER_SAMPLER_TYPE=const JAEGER_SAMPLER_PARAM=1 java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] -ifndef::uses-jaeger[] -$ java -jar target/{artifactId}-bootable.jar -endif::uses-jaeger[] ----- - -. You can now interact with the quickstart application. - -// Bootable Jar Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_bootable_jar_]] -= Run the Integration Tests with a bootable jar += Building and Running the quickstart application in a bootable JAR //****************************************************************************** // This template sets attributes for the different standalone server profiles. @@ -1321,40 +1126,87 @@ ifndef::serverProfile[] :serverArguments: endif::serverProfile[] -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a bootable jar. +ifndef::mavenServerProvisioningCommand[] +ifeval::["{archiveType}"=="ear"] +:mavenServerProvisioningCommand: clean install +endif::[] +ifeval::["{archiveType}"=="war"] +:mavenServerProvisioningCommand: clean package +endif::[] +ifeval::["{archiveType}"=="jar"] +:mavenServerProvisioningCommand: clean install +endif::[] +endif::mavenServerProvisioningCommand[] -Follow these steps to run the integration tests. +You can use the WildFly Maven Plugin to build a {productName} bootable JAR to run this quickstart. + +The quickstart `pom.xml` file contains a Maven profile named *bootable-jar*, which configures the bootable JAR building: + +[source,xml,subs="attributes+"] +---- + + bootable-jar + + true + + + + + org.wildfly.plugins + wildfly-maven-plugin + + + ${version.server} + + true + ... + + + + + package + + + + + ... + + + +---- + +The *bootable-jar* profile is activate by default, and when built the {productName} bootable jar may be found at `target/{artifactId}-bootable.jar` + +.Procedure -. Make sure the bootable jar is provisioned. +. Ensure the bootable jar is built. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn clean package -Pbootable-jar +$ mvn clean {mavenServerProvisioningCommand} ---- -. Start the {productName} bootable jar, this time using the {productName} Maven Jar Plugin, which is recommend for testing due to simpler automation. +. Start the {productName} bootable jar use the WildFly Maven Plugin `start-jar` goal. + [source,subs="attributes+",options="nowrap"] ---- $ mvn wildfly:start-jar ---- -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Run the integration tests use the `verify` goal, with the `integration-testing` profile activated. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing ---- -. Shutdown the {productName} bootable jar, this time using the {productName} Maven Jar Plugin too. +. Shut down the {productName} bootable jar use the WildFly Maven Plugin `shutdown` goal. + [source,options="nowrap"] ---- $ mvn wildfly:shutdown ---- -:leveloffset: 1 - :leveloffset!: // OpenShift :leveloffset: +1 diff --git a/remote-helloworld-mdb/README.adoc b/remote-helloworld-mdb/README.adoc index 2090835e12..bb6f949438 100644 --- a/remote-helloworld-mdb/README.adoc +++ b/remote-helloworld-mdb/README.adoc @@ -588,6 +588,19 @@ INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-5 (ActiveM INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-4 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 5 ---- +// Additional information about this script +This script removes the remote broker connection from the `messaging-activemq` subsystem and restore the `default` internal broker. You should see the following result when you run the script: + +[source,options="nowrap"] +---- +"outcome" => "success", +"response-headers" => { + "operation-requires-reload" => true, + "process-state" => "reload-required" +} +---- + + // Server Distribution Testing :leveloffset: +2 @@ -610,21 +623,33 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: +[NOTE] +==== +The integration tests expect a running {BrokerProductName} broker, so make sure you have started the broker before you begin. +==== +// Undeploy the Quickstart +:leveloffset: +2 -// Additional information about this script -This script removes the remote broker connection from the `messaging-activemq` subsystem and restore the `default` internal broker. You should see the following result when you run the script: +[[undeploy_the_quickstart]] += Undeploy the Quickstart + +//******************************************************************************* +// Include this template if your quickstart does a normal undeployment of an archive. +//******************************************************************************* +When you are finished testing the quickstart, follow these steps to undeploy the archive. +. Make sure {productName} server is started. +. Open a terminal and navigate to the root directory of this quickstart. +. Type this command to undeploy the archive: ++ [source,options="nowrap"] ---- -"outcome" => "success", -"response-headers" => { - "operation-requires-reload" => true, - "process-state" => "reload-required" -} +$ mvn wildfly:undeploy ---- +:leveloffset!: // Restore the {productName} Standalone Server Configuration Manually -:leveloffset: +3 +:leveloffset: +2 [[restore_standalone_server_configuration_manually]] = Restore the {productName} Standalone Server Configuration Manually @@ -703,31 +728,6 @@ When you have completed testing the quickstart, you can restore the original ser :leveloffset!: -:leveloffset: +2 - -[[undeploy_the_quickstart]] -= Undeploy the Quickstart - -//******************************************************************************* -// Include this template if your quickstart does a normal undeployment of an archive. -//******************************************************************************* -When you are finished testing the quickstart, follow these steps to undeploy the archive. - -. Make sure {productName} server is started. -. Open a terminal and navigate to the root directory of this quickstart. -. Type this command to undeploy the archive: -+ -[source,options="nowrap"] ----- -$ mvn wildfly:undeploy ----- - -:leveloffset!: - -[NOTE] -==== -The integration tests expect a running {BrokerProductName} broker, so make sure you have started the broker before you begin. -==== // Build and run sections for other environments/builds ifndef::ProductRelease,EAPXPRelease[] :leveloffset: +1 @@ -752,45 +752,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -815,113 +788,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -946,7 +824,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -957,18 +835,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -983,8 +861,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/security-domain-to-domain/README.adoc b/security-domain-to-domain/README.adoc index b16f8936d2..3a19896856 100644 --- a/security-domain-to-domain/README.adoc +++ b/security-domain-to-domain/README.adoc @@ -789,7 +789,7 @@ Caller Has Role 'Manager'=true This shows that the user `quickstartUser` calls the servlet and has role `User` but does not have the role `Manager`, as the call reaches the EJB the principal is still `quickstartUser` but now the identity does not have the role `User` and instead has the role `Manager`. // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -810,6 +810,7 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} ---- :leveloffset!: + // Undeploy the Quickstart :leveloffset: +1 @@ -972,45 +973,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1035,113 +1009,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] +Follow these steps to run the quickstart using the provisioned server. -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1166,7 +1045,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1177,18 +1056,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1203,8 +1082,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] diff --git a/servlet-async/README.adoc b/servlet-async/README.adoc index 77a1d4a2c5..f674d193eb 100644 --- a/servlet-async/README.adoc +++ b/servlet-async/README.adoc @@ -574,45 +574,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -637,113 +610,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -768,7 +646,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -779,18 +657,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -805,8 +683,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/servlet-filterlistener/README.adoc b/servlet-filterlistener/README.adoc index 5215b112cc..f199fd265f 100644 --- a/servlet-filterlistener/README.adoc +++ b/servlet-filterlistener/README.adoc @@ -621,45 +621,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -684,113 +657,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -815,7 +693,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -826,18 +704,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -852,8 +730,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/servlet-security/README.adoc b/servlet-security/README.adoc index 68c1394de3..88741ee632 100644 --- a/servlet-security/README.adoc +++ b/servlet-security/README.adoc @@ -646,6 +646,28 @@ The purpose of a `role-decoder` is to instruct the security domain how roles are This configuration tells `Undertow` that applications with the `servlet-security-quickstart` security domain, as defined in the `jboss-web.xml` or by using the `@SecurityDomain` annotation in the Servlet class, should use the `security-domain` named `servlet-security-quickstart-sd`. +// Server Distribution Testing +:leveloffset: +2 + +[[run_the_integration_tests_with_server_distribution]] += Run the Integration Tests +ifndef::integrationTestsDirectory[:integrationTestsDirectory: src/test/] +ifndef::extraStandardDistTestParams[:extraStandardDistTestParams: ] + +This quickstart includes integration tests, which are located under the `{integrationTestsDirectory}` directory. The integration tests verify that the quickstart runs correctly when deployed on the server. + +Follow these steps to run the integration tests. + +. Make sure {productName} server is started. +. Make sure the quickstart is deployed. +. Type the following command to run the `verify` goal with the `integration-testing` profile activated. ++ +[source,subs="attributes+",options="nowrap"] +---- +$ mvn verify -Pintegration-testing {extraStandardDistTestParams} +---- + +:leveloffset!: // Build and Deploy the Quickstart :leveloffset: +2 @@ -772,28 +794,6 @@ Now close the browser. Open a new browser and log in with username `guest` and p Forbidden ---- -// Server Distribution Testing -:leveloffset: +2 - -[[run_the_integration_tests_with_server_distribution]] -= Run the Integration Tests -ifndef::integrationTestsDirectory[:integrationTestsDirectory: src/test/] -ifndef::extraStandardDistTestParams[:extraStandardDistTestParams: ] - -This quickstart includes integration tests, which are located under the `{integrationTestsDirectory}` directory. The integration tests verify that the quickstart runs correctly when deployed on the server. - -Follow these steps to run the integration tests. - -. Make sure {productName} server is started. -. Make sure the quickstart is deployed. -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn verify -Pintegration-testing {extraStandardDistTestParams} ----- - -:leveloffset!: // Undeploy the Quickstart :leveloffset: +2 @@ -965,45 +965,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -1028,113 +1001,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -1159,7 +1037,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1170,18 +1048,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -1196,8 +1074,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/spring-resteasy/README.adoc b/spring-resteasy/README.adoc index f7eb1d2a28..4cf36f4dab 100644 --- a/spring-resteasy/README.adoc +++ b/spring-resteasy/README.adoc @@ -533,7 +533,7 @@ WARN [org.jboss.as.ee] (MSC service thread 1-5) WFLYEE0007: Not installing opti ---- // Server Distribution Testing -:leveloffset: +2 +:leveloffset: +1 [[run_the_integration_tests_with_server_distribution]] = Run the Integration Tests @@ -555,7 +555,7 @@ $ mvn verify -Pintegration-testing {extraStandardDistTestParams} :leveloffset!: // Undeploy the Quickstart -:leveloffset: +2 +:leveloffset: +1 [[undeploy_the_quickstart]] = Undeploy the Quickstart @@ -600,45 +600,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -663,113 +636,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. +Follow these steps to run the quickstart using the provisioned server. -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -794,7 +672,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -805,18 +683,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -831,8 +709,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/tasks-jsf/README.adoc b/tasks-jsf/README.adoc index 0159238488..0340f8fce4 100644 --- a/tasks-jsf/README.adoc +++ b/tasks-jsf/README.adoc @@ -623,45 +623,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -686,113 +659,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -817,7 +695,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -828,18 +706,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -854,8 +732,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/temperature-converter/README.adoc b/temperature-converter/README.adoc index c0a06f3b8d..9b60eabd49 100644 --- a/temperature-converter/README.adoc +++ b/temperature-converter/README.adoc @@ -584,45 +584,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -647,113 +620,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -778,7 +656,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -789,18 +667,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -815,8 +693,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/thread-racing/README.adoc b/thread-racing/README.adoc index d1de68dabd..848a6ead31 100644 --- a/thread-racing/README.adoc +++ b/thread-racing/README.adoc @@ -626,45 +626,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -689,113 +662,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -820,7 +698,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -831,18 +709,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -857,8 +735,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/todo-backend/README.adoc b/todo-backend/README.adoc index 3d5d061524..790c8a45a3 100644 --- a/todo-backend/README.adoc +++ b/todo-backend/README.adoc @@ -428,166 +428,12 @@ $ curl http://localhost:8080/todo-backend [{"completed":false,"id":1,"order":0,"title":"This is my first todo item!","url":"https://localhost:8080/1"}] ---- -:extraStartParams: -DPOSTGRESQL_DATABASE=todos -DPOSTGRESQL_SERVICE_HOST=localhost -DPOSTGRESQL_SERVICE_PORT=5432 -DPOSTGRESQL_USER=todos -DPOSTGRESQL_PASSWORD=mysecretpassword -DPOSTGRESQL_DATASOURCE=ToDos -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] - -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] - -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] - -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. - -. Make sure the server is provisioned. -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- +Please note that the quickstart includes integration tests, which may be executed using the following command: -ifdef::addQuickstartUser[] -. Add the quickstart user: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -endif::[] - -ifdef::addQuickstartAdmin[] -. Add the quickstart admin: -+ -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. -+ -ifndef::deploymentDir[] -[source,subs="attributes+",options="nowrap"] ----- -$ mvn wildfly:start {extraStartParams} ----- -endif::[] -ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn verify -Pintegration-testing ---- -endif::[] - -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. -+ -[source,subs="attributes+",options="nowrap"] ----- -$ mvn verify -Pintegration-testing {extraProvisioningTestParams} ----- - -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. -+ -ifndef::deploymentDir[] -[source,subs="attributes+",options="nowrap"] ----- -$ mvn wildfly:shutdown ----- -endif::[] -ifdef::deploymentDir[] -[source,subs="attributes+",options="nowrap"] ----- -$ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ----- -endif::[] - -:leveloffset!: //=========================================================== // Openshift - START diff --git a/websocket-endpoint/README.adoc b/websocket-endpoint/README.adoc index 044757a716..e61d806967 100644 --- a/websocket-endpoint/README.adoc +++ b/websocket-endpoint/README.adoc @@ -582,45 +582,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -645,113 +618,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -776,7 +654,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -787,18 +665,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -813,8 +691,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1 diff --git a/websocket-hello/README.adoc b/websocket-hello/README.adoc index 28478bf26f..68d1ce8b02 100644 --- a/websocket-hello/README.adoc +++ b/websocket-hello/README.adoc @@ -588,45 +588,18 @@ ifndef::deploymentDir[:deploymentTargetDir: target] ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] endif::deploymentTargetDir[] -Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart, by activating the Maven profile named `provisioned-server` when building the quickstart: - -[source,subs="attributes+",options="nowrap"] ----- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server ----- - -The provisioned {productName} server, with the quickstart deployed, can then be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. - -ifdef::addQuickstartUser[] -The quickstart user should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' {app-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] - -ifdef::addQuickstartAdmin[] -The quickstart admin should be added before running the provisioned server: -[source,subs="+quotes,attributes+",options="nowrap"] ----- -$ {deploymentTargetDir}/server/bin/add-user.sh -a -u 'quickstartAdmin' -p 'adminPwd1!' {admin-group-command} ----- -[NOTE] -==== -For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. -==== -endif::[] +ifndef::extraStartParams[:extraStartParams: ] +ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] -The server provisioning functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: +Instead of using a standard {productName} server distribution, you can alternatively provision a {productName} server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart `pom.xml`: [source,xml,subs="attributes+"] ---- provisioned-server + + true + @@ -651,113 +624,18 @@ The server provisioning functionality is provided by the WildFly Maven Plugin, a ---- -The plugin uses https://github.com/wildfly/wildfly-glow[WildFly Glow] to discover the feature packs and layers required to run the application, and provisions a server containing those layers. - -If you get an error or the server is missing some functionality which cannot be auto-discovered, you can download the https://github.com/wildfly/wildfly-glow/releases/tag[WildFly Glow CLI] and run the following command to see more information about what add-ons are available: - -[source,shell] ----- -wildfly-glow show-add-ons ----- - -// Server Provisioning Testing -:leveloffset: +1 - -[[run_the_integration_tests_with_provisioned_server_]] -= Run the Integration Tests with a provisioned server - -//****************************************************************************** -// This template sets attributes for the different standalone server profiles. -// -// You must define the `standalone-server-type`. Supported values are: -// default -// full -// full-ha -// ha -// microprofile -// custom -//****************************************************************************** - -// Standalone server with the default profile. -ifeval::["{standalone-server-type}"=="default"] -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::[] - -// Standalone server with the full profile. -ifeval::["{standalone-server-type}"=="full"] -:serverProfile: full profile -:configFileName: standalone/configuration/standalone-full.xml -:serverArguments: -c standalone-full.xml -endif::[] - -// Standalone server with the full HA profile. -ifeval::["{standalone-server-type}"=="full-ha"] -:serverProfile: full HA profile -:configFileName: standalone/configuration/standalone-full-ha.xml -:serverArguments: -c standalone-full-ha.xml -endif::[] -// Start the standalone server with the HA profile. -ifeval::["{standalone-server-type}"=="ha"] -:serverProfile: HA profile -:configFileName: standalone/configuration/standalone-ha.xml -:serverArguments: -c standalone-ha.xml -endif::[] +When built, the provisioned {productName} server can be found in the `{deploymentTargetDir}/server` directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started. -// Start the standalone server with the Eclipse MicroProfile profile. -ifeval::["{standalone-server-type}"=="microprofile"] -:serverProfile: MicroProfile profile -:configFileName: standalone/configuration/standalone-microprofile.xml -:serverArguments: -c standalone-microprofile.xml -endif::[] +Follow these steps to run the quickstart using the provisioned server. -// Standalone server with the custom profile. -// NOTE: This profile requires that you define the `serverArguments` variable -// within the quickstart README.adoc file. For example: -// :serverArguments: --server-config=../../docs/examples/configs/standalone-xts.xml -ifeval::["{standalone-server-type}"=="custom"] -:serverProfile: custom profile -endif::[] - -// If there is no match, use the default profile. -ifndef::serverProfile[] -:standalone-server-type: default -:serverProfile: default profile -:configFileName: standalone/configuration/standalone.xml -:serverArguments: -endif::serverProfile[] - -ifndef::mavenServerProvisioningCommand[] -ifeval::["{archiveType}"=="ear"] -:mavenServerProvisioningCommand: clean install -endif::[] -ifeval::["{archiveType}"=="war"] -:mavenServerProvisioningCommand: clean package -endif::[] -ifeval::["{archiveType}"=="jar"] -:mavenServerProvisioningCommand: clean install -endif::[] -endif::mavenServerProvisioningCommand[] - -ifndef::deploymentTargetDir[] -ifndef::deploymentDir[:deploymentTargetDir: target] -ifdef::deploymentDir[:deploymentTargetDir: {deploymentDir}/target] -endif::deploymentTargetDir[] - -ifndef::extraStartParams[:extraStartParams: ] -ifndef::extraProvisioningTestParams[:extraProvisioningTestParams: ] - -The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with a provisioned server. - -Follow these steps to run the integration tests. +.Procedure . Make sure the server is provisioned. + [source,subs="attributes+",options="nowrap"] ---- -$ mvn {mavenServerProvisioningCommand} -Pprovisioned-server +$ mvn {mavenServerProvisioningCommand} ---- ifdef::addQuickstartUser[] @@ -782,7 +660,7 @@ For Windows, use the `__{jbossHomeName}__\bin\add-user.bat` script. ==== endif::[] -. Start the {productName} provisioned server, this time using the {productName} Maven Plugin, which is recommended for testing due to simpler automation. +. Start the {productName} provisioned server, using the WildFly Maven Plugin `start` goal. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -793,18 +671,18 @@ endif::[] ifdef::deploymentDir[] [source,subs="attributes+",options="nowrap"] ---- -$ mvn -f {deploymentDir}/pom.xml wildfly:start -DjbossHome={deploymentDir}/target/server {extraStartParams} +$ mvn -f {deploymentDir}/pom.xml wildfly:start {extraStartParams} ---- endif::[] -. Type the following command to run the `verify` goal with the `integration-testing` profile activated. +. Type the following command to run the integration tests. + [source,subs="attributes+",options="nowrap"] ---- $ mvn verify -Pintegration-testing {extraProvisioningTestParams} ---- -. Shutdown the {productName} provisioned server, this time using the {productName} Maven Plugin too. +. Shut down the {productName} provisioned server. + ifndef::deploymentDir[] [source,subs="attributes+",options="nowrap"] @@ -819,8 +697,6 @@ $ mvn -f {deploymentDir}/pom.xml wildfly:shutdown ---- endif::[] -:leveloffset: 1 - :leveloffset!: endif::[] :leveloffset: +1