Skip to content

Commit

Permalink
Merge pull request #55 from jamezp/clean-white-space
Browse files Browse the repository at this point in the history
Replace tabs with spaces and remove trailing whitespace.
  • Loading branch information
jamezp authored Oct 20, 2023
2 parents d6cdc16 + dfd90e8 commit 45e6b12
Show file tree
Hide file tree
Showing 51 changed files with 188 additions and 189 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ jobs:
$JBOSS_HOME/bin/standalone.sh &
until `$JBOSS_HOME/bin/jboss-cli.sh -c ":read-attribute(name=server-state)" 2> /dev/null | grep -q running`; do
sleep 1
done
done
./runtest_remote.sh $ARCHETYPE_VERSION
$JBOSS_HOME/bin/jboss-cli.sh --connect command=:shutdown
echo " * :white_check_mark: Remote Tests" >> $GITHUB_STEP_SUMMARY
Expand Down Expand Up @@ -89,4 +89,3 @@ jobs:
rm -rf wildfly-jakartaee-webapp-archetype/testing/arq-remote
rm -rf wildfly-jakartaee-webapp-archetype/testing/arq-managed
rm -rf wildfly-subsystem-archetype/testing/example-subsystem
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Archetype is a Maven project templating toolkit
Basic Steps
-----------

To contribute to the Archetypes, fork the Archetypes repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.
To contribute to the Archetypes, fork the Archetypes repository to your own Git, clone your fork, commit your work on topic branches, and make pull requests.

If you don't have the Git client (`git`), get it from: <http://git-scm.com/>

Expand Down Expand Up @@ -58,7 +58,7 @@ Here are the steps in detail:

9. Push your local topic branch to your github forked repository. This will create a branch on your Git fork repository with the same name as your local topic branch name.

git push origin HEAD
git push origin HEAD

10. Browse to the <topic-branch-name> branch on your forked Git repository and [open a Pull Request](http://help.github.com/send-pull-requests/). Give it a clear title and description.

Expand All @@ -70,7 +70,7 @@ General Guidelines
License Information and Contributor Agreement
---------------------------------------------

JBoss Developer Framework is licensed under the Apache License 2.0, as we believe it is one of the most permissive Open Source license. This allows developers to easily make use of the code samples in JBoss Developer Framework.
JBoss Developer Framework is licensed under the Apache License 2.0, as we believe it is one of the most permissive Open Source license. This allows developers to easily make use of the code samples in JBoss Developer Framework.

There is no need to sign a contributor agreement to contribute to JBoss Developer Framework. You just need to explicitly license any contribution under the AL 2.0. If you add any new files to JBoss Developer Framework, make sure to add the correct header.

Expand All @@ -79,15 +79,15 @@ License Information and Contributor Agreement
/*
* JBoss, Home of Professional Open Source
* Copyright <Year>, Red Hat, Inc. and/or its affiliates, and individual
* contributors by the @authors tag. See the copyright.txt in the
* contributors by the @authors tag. See the copyright.txt in the
* distribution for a full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
Expand All @@ -98,15 +98,15 @@ License Information and Contributor Agreement
<!--
JBoss, Home of Professional Open Source
Copyright <Year>, Red Hat, Inc. and/or its affiliates, and individual
contributors by the @authors tag. See the copyright.txt in the
contributors by the @authors tag. See the copyright.txt in the
distribution for a full listing of individual contributors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Expand All @@ -116,15 +116,15 @@ License Information and Contributor Agreement

# JBoss, Home of Professional Open Source
# Copyright <Year>, Red Hat, Inc. and/or its affiliates, and individual
# contributors by the @authors tag. See the copyright.txt in the
# contributors by the @authors tag. See the copyright.txt in the
# distribution for a full listing of individual contributors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
dependencies and plugins that are references by the generated project
are defined in the parent pom and evaluated when the archetype are built.
This project defines pluginManagment and dependencyManagemet to trigger
This project defines pluginManagment and dependencyManagemet to trigger
dependencies updates even though this project and its submodules does not
actually use these dependencies.
-->
Expand Down
2 changes: 1 addition & 1 deletion wildfly-getting-started-archetype/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ service and a HTML page to call the web service.
The generated project is configured to dynamically provision a WildFly server
and run the web application on the provisoned server so no manual installation
is required.

It is prepared for running Arquillian unit tests.
More details can be found in the file "src/main/resources/archetype-resources/README.txt", which is end-user doc and added to the resulting project.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@
<description>Insert description for your project here.</description>

<properties>
<!-- Explicitly declaring the source encoding eliminates the following
<!-- Explicitly declaring the source encoding eliminates the following
message: -->
<!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered
<!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered
resources, i.e. build is platform dependent! -->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

Expand Down Expand Up @@ -78,8 +78,8 @@
<dependencyManagement>
<dependencies>
<!-- JBoss distributes a complete set of Jakarta EE APIs including
a Bill of Materials (BOM). A BOM specifies the versions of a "stack" (or
a collection) of artifacts. We use this here so that we always get the correct
a Bill of Materials (BOM). A BOM specifies the versions of a "stack" (or
a collection) of artifacts. We use this here so that we always get the correct
versions of artifacts (you can read this as the WildFly stack of the Jakarta EE APIs,
with some extras tools for your project, such as Arquillian for testing) -->
<dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

= ${artifactId}

The `${artifactId}` project is a simple Jakarta EE application with a HTTP endpoint that is running in
The `${artifactId}` project is a simple Jakarta EE application with a HTTP endpoint that is running in
https://wildfly.org[WildFly].

The `src/main` folder contains a simple 'Hello world' style Jakarta EE application using JAX-RS.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
@Path("/")
public class ${defaultClassPrefix}Endpoint {

@Inject
private ${defaultClassPrefix}Service service;
@Inject
private ${defaultClassPrefix}Service service;

@GET
@Path("/{name}")
@Produces(MediaType.TEXT_PLAIN)
public Response sayHello(final @PathParam("name") String name) {
String response = service.hello(name);
return Response.ok(response).build();
}
@GET
@Path("/{name}")
@Produces(MediaType.TEXT_PLAIN)
public Response sayHello(final @PathParam("name") String name) {
String response = service.hello(name);

return Response.ok(response).build();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ <h1>Getting Started</h1>
</div>
</div>
<footer>
<p>This page is served by your application. The source is in <code>src/main/webapp/index.html</code>.</p>
<p>This page is served by your application. The source is in <code>src/main/webapp/index.html</code>.</p>
</footer>
</body>
</html>
2 changes: 1 addition & 1 deletion wildfly-jakartaee-ear-archetype/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ WildFly archetype for blank EAR project
[[introduction]]
==== Introduction

This archetype creates a blank EAR project with EJB and Web module.
This archetype creates a blank EAR project with EJB and Web module.
It is prepared for running Arquillian unit tests.
More details can be found in the file "src/main/resources/archetype-resources/README.txt", which is end-user doc and added to the resulting project.

Expand Down
2 changes: 1 addition & 1 deletion wildfly-jakartaee-ear-archetype/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<version>30.0.1.Final-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

<artifactId>wildfly-jakartaee-ear-archetype</artifactId>
<packaging>maven-archetype</packaging>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<groupId>\${groupId}</groupId>
<artifactId>\${rootArtifactId}</artifactId>
<version>\${version}</version>

<packaging>pom</packaging>
<name>\${rootArtifactId}</name>
<description>Insert description for your project here.</description>
Expand All @@ -33,9 +33,9 @@
</modules>

<properties>
<!-- Explicitly declaring the source encoding eliminates the following
<!-- Explicitly declaring the source encoding eliminates the following
message: -->
<!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered
<!-- [WARNING] Using platform encoding (UTF-8 actually) to copy filtered
resources, i.e. build is platform dependent! -->
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

Expand Down Expand Up @@ -109,10 +109,10 @@
<type>war</type>
<scope>compile</scope>
</dependency>

<!-- JBoss distributes a complete set of Jakarta EE 8 APIs including
a Bill of Materials (BOM). A BOM specifies the versions of a "stack" (or
a collection) of artifacts. We use this here so that we always get the correct
a Bill of Materials (BOM). A BOM specifies the versions of a "stack" (or
a collection) of artifacts. We use this here so that we always get the correct
versions of artifacts. Here we use the wildfly-jakartaee-8.0-with-tools stack
(you can read this as the WildFly stack of the Jakarta EE 8 APIs -->
<dependency>
Expand All @@ -136,7 +136,7 @@
</configuration>
</plugin>
<!-- The WildFly plugin deploys your ear to a local JBoss AS container -->
<!-- Due to Maven's lack of intelligence with EARs we need
<!-- Due to Maven's lack of intelligence with EARs we need
to configure the wildfly maven plugin to skip deployment for all modules.
We then enable it specifically in the ear module. -->
<plugin>
Expand All @@ -159,7 +159,7 @@
<activeByDefault>true</activeByDefault>
</activation>
</profile>

<profile>
<!-- An optional Arquillian testing profile that executes tests in your WildFly / JBoss EAP instance.
This profile will start a new WildFly / JBoss EAP instance, and execute the test, shutting it down when done.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Licensed under the Apache License, Version 2.0 (the "License"); you
may not use this file except in compliance with the License. You may obtain
a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the License for
<!-- Licensed under the Apache License, Version 2.0 (the "License"); you
may not use this file except in compliance with the License. You may obtain
a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
OR CONDITIONS OF ANY KIND, either express or implied. See the License for
the specific language governing permissions and limitations under the License. -->
<archetype-descriptor name="wildfly-jakartaee-webapp-ear-archetype">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ The configuration can be found in "${rootArtifactId}/pom.xml":

Three profiles are defined:
-"default": no integration tests are executed.
-"arq-remote": you have to start a WildFly server on your machine. The tests are executed by deploying
-"arq-remote": you have to start a WildFly server on your machine. The tests are executed by deploying
the application to this server.
Here the "maven-failsafe-plugin" is enabled so that integration tests can be run.
Run maven with these arguments: "clean verify -Parq-remote"
-"arq-managed": this requires the environment variable "JBOSS_HOME" to be set:
-"arq-managed": this requires the environment variable "JBOSS_HOME" to be set:
The server found in this path is started and the tests are executed by deploying the application to this server.
Instead of using this environment variable, you can also define the path in "arquillian.xml".
Here the "maven-failsafe-plugin" is enabled so that integration tests can be run.
Run maven with these arguments: "clean verify -Parq-managed"

The Arquillian test runner is configured with the file "src/test/resources/arquillian.xml"
The Arquillian test runner is configured with the file "src/test/resources/arquillian.xml"
(duplicated in EJB and WEB project, depending where your tests are placed).
The profile "arq-remote" uses the container qualifier "remote" in this file.
The profile "arq-managed" uses the container qualifier "managed" in this file.
Expand All @@ -53,7 +53,7 @@ You can delete this test file if no tests are necessary.

Why integration tests instead of the "maven-surefire-plugin" testrunner?
The Arquillian test runner deploys the EAR file to the WildFly server and thus you have to build it yourself with the ShrinkWrap API.
The goal "verify" (which triggers the maven-surefire-plugin) is executed later in the maven build lifecyle than the "test" goal so that the target
The goal "verify" (which triggers the maven-surefire-plugin) is executed later in the maven build lifecyle than the "test" goal so that the target
artifacts ("${rootArtifactId}-ejb.jar" and "${rootArtifactId}-web.war") are already built. You can build
the final EAR by including those files. The "maven-surefire-plugin" is executed before the JAR/WAR files
are created, so those JAR/WAR files would have to be built in the "@Deployment" method, too.
are created, so those JAR/WAR files would have to be built in the "@Deployment" method, too.
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
<build>
<finalName>${project.parent.artifactId}</finalName>
<plugins>
<!--EAR plugin: format of output file -->
<!--EAR plugin: format of output file -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-ear-plugin</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@
<scope>test</scope>
</dependency>

<!-- Bean Validation Implementation
Provides portable constraints such as @Email
<!-- Bean Validation Implementation
Provides portable constraints such as @Email
Hibernate Validator is shipped in WildFly / JBoss EAP -->
<dependency>
<groupId>org.hibernate.validator</groupId>
Expand Down Expand Up @@ -91,13 +91,13 @@
</dependencies>

<build>
<!-- Tell Maven that the resulting file should not have a file name containing the version -
a non versioned name is required e.g. when building a deployable artifact using the ShrinkWrap API -->
<!-- Tell Maven that the resulting file should not have a file name containing the version -
a non versioned name is required e.g. when building a deployable artifact using the ShrinkWrap API -->
<finalName>${project.artifactId}</finalName>

<plugins>
<!--Configure the EJB plugin: we create EJB 4.0. If not specified, an error will arise because the plugin expects an Ejb-jar by default. -->
<plugin>
<plugins>
<!--Configure the EJB plugin: we create EJB 4.0. If not specified, an error will arise because the plugin expects an Ejb-jar by default. -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-ejb-plugin</artifactId>
<version>${version.ejb.plugin}</version>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<property name="jbossHome">EAP_HOME</property>
</configuration> -->
</container>

<!-- Example configuration for a remote WildFly / JBoss EAP instance -->
<container qualifier="remote">
<!-- Arquillian will deploy to this WildFly server. -->
Expand Down
Loading

0 comments on commit 45e6b12

Please sign in to comment.