Fixes #4103 - Update Piranha Core Profile - Create a JSON REST servic…

…e guide (#4153)
piranhacloud · Nov 2, 2024 · 2146496 · 2146496
1 parent b7a2685
commit 2146496
Show file tree

Hide file tree

Showing 6 changed files with 361 additions and 2 deletions.
diff --git a/test/coreprofile/json/pom.xml b/test/coreprofile/json/pom.xml
@@ -0,0 +1,125 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project
+    xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>cloud.piranha.test.coreprofile</groupId>
+        <artifactId>project</artifactId>
+        <version>24.11.0-SNAPSHOT</version>
+    </parent>
+    <artifactId>piranha-test-coreprofile-json</artifactId>
+    <packaging>war</packaging>
+    <name>Piranha - Test - Core Profile - Create a JSON temperature service</name>
+    <properties>
+        <!-- other -->
+        <piranha.version>${project.version}</piranha.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+    <dependencies>
+        <dependency>
+            <groupId>jakarta.platform</groupId>
+            <artifactId>jakarta.jakartaee-core-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+    <build>
+        <finalName>temperature</finalName>
+        <plugins>
+            <plugin>
+                <groupId>cloud.piranha.maven</groupId>
+                <artifactId>piranha-maven-plugin</artifactId>
+                <version>${piranha.version}</version>
+                <executions>
+                    <execution>
+                        <id>pre-integration-test</id>
+                        <phase>pre-integration-test</phase>
+                        <goals>
+                            <goal>start</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>post-integration-test</id>
+                        <phase>post-integration-test</phase>
+                        <goals>
+                            <goal>stop</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <httpPort>${httpPort}</httpPort>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>${maven-compiler-plugin.version}</version>
+                <configuration>
+                    <release>${java.version}</release>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>${maven-failsafe-plugin.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>integration-test</goal>
+                            <goal>verify</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <forkCount>1</forkCount>
+                    <systemPropertyVariables>
+                        <httpPort>${httpPort}</httpPort>
+                    </systemPropertyVariables>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-war-plugin</artifactId>
+                <version>${maven-war-plugin.version}</version>
+                <configuration>
+                    <failOnMissingWebXml>false</failOnMissingWebXml>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>build-helper-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>reserve-network-port</id>
+                        <goals>
+                            <goal>reserve-network-port</goal>
+                        </goals>
+                        <phase>package</phase>
+                        <configuration>
+                            <portNames>
+                                <portName>httpPort</portName>
+                            </portNames>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>            
+        </plugins>
+    </build>
+</project>
diff --git a/test/coreprofile/json/src/main/java/temperature/Temperature.java b/test/coreprofile/json/src/main/java/temperature/Temperature.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) 2002-2024 Manorrock.com. All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *   3. Neither the name of the copyright holder nor the names of its
+ *      contributors may be used to endorse or promote products derived from
+ *      this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package temperature;
+
+public class Temperature {
+
+    /**
+     * Defines the temperature scale enum.
+     */
+    public enum TemperatureScale {
+        /**
+         * Celsius constant.
+         */
+        CELSIUS,
+        /**
+         * Fahrenheit constant.
+         */
+        FAHRENHEIT
+    }
+
+    /**
+     * Stores the temperature scale.
+     */
+    private TemperatureScale scale;
+
+    /**
+     * Stores the temperature.
+     */
+    private double temperature;
+
+    /**
+     * Get the temperature scale.
+     * 
+     * @return the temperature scale.
+     */
+    public TemperatureScale getScale() {
+        return scale;
+    }
+
+    /**
+     * Get the temperature.
+     * 
+     * @return the temperature.
+     */
+    public double getTemperature() {
+        return temperature;
+    }
+
+    /**
+     * Set the temperature scale.
+     * 
+     * @param scale the temperature scale.
+     */
+    public void setScale(TemperatureScale scale) {
+        this.scale = scale;
+    }
+
+    /**
+     * Set the temperature.
+     * 
+     * @param temperature the temperature.
+     */
+    public void setTemperature(double temperature) {
+        this.temperature = temperature;
+    }
+}
diff --git a/test/coreprofile/json/src/main/java/temperature/TemperatureApplication.java b/test/coreprofile/json/src/main/java/temperature/TemperatureApplication.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2002-2024 Manorrock.com. All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *   3. Neither the name of the copyright holder nor the names of its
+ *      contributors may be used to endorse or promote products derived from
+ *      this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package temperature;
+
+import jakarta.ws.rs.ApplicationPath;
+import jakarta.ws.rs.core.Application;
+
+@ApplicationPath("")
+public class TemperatureApplication extends Application {
+}
diff --git a/test/coreprofile/json/src/main/java/temperature/TemperatureBean.java b/test/coreprofile/json/src/main/java/temperature/TemperatureBean.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2002-2024 Manorrock.com. All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *   3. Neither the name of the copyright holder nor the names of its
+ *      contributors may be used to endorse or promote products derived from
+ *      this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package temperature;
+
+import jakarta.enterprise.context.RequestScoped;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
+import static jakarta.ws.rs.core.MediaType.APPLICATION_JSON;
+import static temperature.Temperature.TemperatureScale.CELSIUS;
+import static temperature.Temperature.TemperatureScale.FAHRENHEIT;
+
+@RequestScoped
+@Path("")
+public class TemperatureBean {
+
+    /**
+     * Get the temperature in celsius.
+     * 
+     * @param celsius the celsius temperature.
+     * @return the celsius tempature.
+     */
+    @GET
+    @Produces(APPLICATION_JSON)
+    @Path("/celsius/{celsius}")
+    public Temperature celsius(@PathParam("celsius") double celsius) {
+        Temperature temp = new Temperature();
+        temp.setScale(CELSIUS);
+        temp.setTemperature(celsius);
+        return temp;
+    }
+
+    /**
+     * Get the temperature in fahrenheit.
+     * 
+     * @param fahrenheit the fahrenheit temperature.
+     * @return the fahrenheit tempature.
+     */
+    @GET
+    @Produces("application/json")
+    @Path("/fahrenheit/{fahrenheit}")
+    public Temperature fahrenheit(@PathParam("fahrenheit") double fahrenheit) {
+        Temperature temp = new Temperature();
+        temp.setScale(FAHRENHEIT);
+        temp.setTemperature(fahrenheit);
+        return temp;
+    }
+}
diff --git a/test/coreprofile/json/src/test/java/temperature/TemperatureIT.java b/test/coreprofile/json/src/test/java/temperature/TemperatureIT.java
@@ -0,0 +1,34 @@
+package temperature;
+
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.net.http.HttpResponse.BodyHandlers;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import org.junit.jupiter.api.Test;
+
+class TemperatureIT {
+
+    private String httpPort = System.getProperty("httpPort");
+
+    @Test
+    void testCelsius() throws Exception {
+        HttpClient client = HttpClient.newHttpClient();
+        HttpRequest request = HttpRequest
+                .newBuilder(new URI("http://localhost:" + httpPort + "/temperature/celsius/18.5"))
+                .build();
+        HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
+        assertEquals("{\"scale\":\"CELSIUS\",\"temperature\":18.5}", response.body());
+    }
+
+    @Test
+    void testFahrenheit() throws Exception {
+        HttpClient client = HttpClient.newHttpClient();
+        HttpRequest request = HttpRequest
+                .newBuilder(new URI("http://localhost:" + httpPort + "/temperature/fahrenheit/68.0"))
+                .build();
+        HttpResponse<String> response = client.send(request, BodyHandlers.ofString());
+        assertEquals("{\"scale\":\"FAHRENHEIT\",\"temperature\":68.0}", response.body());
+    }
+}
diff --git a/test/coreprofile/pom.xml b/test/coreprofile/pom.xml
@@ -26,12 +26,12 @@
             <artifactId>piranha-dist-coreprofile</artifactId>
             <version>${project.version}</version>
             <scope>provided</scope>
-            <type>jar</type>
-            <optional>true</optional>
+            <type>pom</type>
         </dependency>
     </dependencies>
     <modules>
         <module>helloarquillian</module>
         <module>hello</module>
+        <module>json</module>
     </modules>
 </project>