feat: add version and deployment timestamp (#2)

bcgov · May 29, 2024 · dae2cc0 · dae2cc0
1 parent d6e4708
commit dae2cc0
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 1 deletion.
diff --git a/pom.xml b/pom.xml
@@ -4,12 +4,15 @@
   <groupId>bcgov.example</groupId>
   <artifactId>java-maven-pipeline-example</artifactId>
   <packaging>war</packaging>
-  <version>1.0.0-SNAPSHOT</version>
+  <version>1.0.1-SNAPSHOT</version>
   <name>java-maven-pipeline-example</name>
   <properties>
     <maven.compiler.source>1.8</maven.compiler.source>
     <maven.compiler.target>1.8</maven.compiler.target>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
   </properties>
+
   <repositories>
     <repository>
       <id>central</id>
@@ -27,14 +30,22 @@
       <url>https://apps.nrs.gov.bc.ca/nexus/content/groups/public/</url>
     </repository>
   </repositories>
+
   <dependencies>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
       <version>3.8.1</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>javax.servlet</groupId>
+      <artifactId>javax.servlet-api</artifactId>
+      <version>4.0.1</version>
+      <scope>provided</scope>
+    </dependency>
   </dependencies>
+
   <build>
     <plugins>
       <!-- Maven Compiler Plugin -->
@@ -47,6 +58,7 @@
           <target>1.8</target>          <!-- Change as needed -->
         </configuration>
       </plugin>
+
       <!-- Maven dependency Plugin -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -82,6 +94,7 @@
       </plugin>
     </plugins>
   </build>
+
   <profiles>
     <profile>
       <id>github</id>

diff --git a/src/main/java/com/example/DeploymentTimestampListener.java b/src/main/java/com/example/DeploymentTimestampListener.java
@@ -0,0 +1,22 @@
+package com.example;
+
+import javax.servlet.ServletContextEvent;
+import javax.servlet.ServletContextListener;
+import javax.servlet.annotation.WebListener;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+@WebListener
+public class DeploymentTimestampListener implements ServletContextListener {
+
+    @Override
+    public void contextInitialized(ServletContextEvent sce) {
+        String timestamp = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
+        sce.getServletContext().setAttribute("deploymentTimestamp", timestamp);
+    }
+
+    @Override
+    public void contextDestroyed(ServletContextEvent sce) {
+        // No need to handle
+    }
+}
diff --git a/src/main/webapp/WEB-INF/web.xml b/src/main/webapp/WEB-INF/web.xml
@@ -4,4 +4,7 @@
 
 <web-app>
   <display-name>Web Application for testing</display-name>
+  <listener>
+    <listener-class>com.example.DeploymentTimestampListener</listener-class>
+  </listener>
 </web-app>
diff --git a/src/main/webapp/index.jsp b/src/main/webapp/index.jsp
@@ -1,5 +1,31 @@
+<%@ page import="java.io.InputStream" %>
+<%@ page import="javax.xml.parsers.DocumentBuilderFactory" %>
+<%@ page import="javax.xml.xpath.XPath" %>
+<%@ page import="javax.xml.xpath.XPathConstants" %>
+<%@ page import="javax.xml.xpath.XPathFactory" %>
+<%@ page import="org.w3c.dom.Document" %>
+<%@ page import="org.w3c.dom.Node" %>
+<%
+    String version = "N/A";
+    try (InputStream input = getServletContext().getResourceAsStream("/META-INF/maven/bcgov.example/java-maven-pipeline-example/pom.xml")) {
+        if (input != null) {
+            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+            Document doc = factory.newDocumentBuilder().parse(input);
+            XPath xpath = XPathFactory.newInstance().newXPath();
+            Node versionNode = (Node) xpath.evaluate("/project/version", doc, XPathConstants.NODE);
+            if (versionNode != null) {
+                version = versionNode.getTextContent();
+            }
+        }
+    } catch (Exception e) {
+        e.printStackTrace();
+    }
+    String timestamp = (String) application.getAttribute("deploymentTimestamp");
+%>
 <html>
 <body>
 <h2>Hello World!</h2>
+<p>Version: <%= version %></p>
+<p>Deployed at: <%= timestamp %></p>
 </body>
 </html>