Merge pull request #39 from mcanoy/versioning

Versioning

Author: mcanoy

.github/workflows/ci-cd.yml

@@ -1,4 +1,4 @@
-name: Java CI
+name: Container Build
 
 on:
   push:
@@ -18,6 +18,18 @@ jobs:
         java-version: 13.0.1
     - name: Build with Maven & Quarkus
       run: mvn test
+    - name: Find and Replace Commit
+      uses: jacobtomlinson/[email protected]
+      with:
+        find: "###GIT_COMMIT###"
+        replace: "${{ github.sha }}"
+        include: ".s2i"
+    - name: Find and Replace Tag
+      uses: jacobtomlinson/[email protected]
+      with:
+        find: "###GIT_TAG###"
+        replace: "${{ github.ref }}"
+        include: ".s2i"
     - uses: redhat-cop/github-actions/s2i@v2
       with:
         base: registry.access.redhat.com/redhat-openjdk-18/openjdk18-openshift:1.8

.github/workflows/pull-request-checks.yml

@@ -1,4 +1,4 @@
-name: Java CI
+name: PR check
 
 on:
 - pull_request

.s2i/environment

@@ -0,0 +1,2 @@
+GIT_API_GIT_COMMIT=###GIT_COMMIT###
+GIT_API_GIT_TAG=###GIT_TAG###

README.md

@@ -1,3 +1,5 @@
+![Container Build](https://github.com/rht-labs/open-management-portal-git-api/workflows/Container%20Build/badge.svg)
+
 # open-management-portal-git-api project
 
 This project uses Quarkus, the Supersonic Subatomic Java Framework.

src/main/java/com/redhat/labs/omp/models/Version.java

@@ -0,0 +1,17 @@
+package com.redhat.labs.omp.models;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class Version {
+    
+    private String gitCommit;
+    private String gitTag;
+
+}

src/main/java/com/redhat/labs/omp/resource/VersionResource.java

@@ -0,0 +1,37 @@
+package com.redhat.labs.omp.resource;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+
+import org.eclipse.microprofile.config.inject.ConfigProperty;
+import org.eclipse.microprofile.metrics.annotation.Counted;
+import org.eclipse.microprofile.metrics.annotation.Timed;
+
+import com.redhat.labs.omp.models.Version;
+
+/**
+ * Provides version information via api. Expected to come from the container in a prod env
+ * @author mcanoy
+ *
+ */
+@Path("/api/v1/version")
+@Produces(MediaType.APPLICATION_JSON)
+@Consumes(MediaType.APPLICATION_JSON)
+public class VersionResource {
+
+    @ConfigProperty(name = "git.commit")
+    String gitCommit;
+    
+    @ConfigProperty(name = "git.tag")
+    String gitTag;
+    
+    @GET
+    @Timed(name="versionResourceTimer")
+    @Counted(name="versionResourceCounter")
+    public Version getVersion() {
+        return new Version(gitCommit, gitTag);
+    }
+}

src/main/resources/application.properties

@@ -37,3 +37,6 @@ residenciesParentRepositoryId=${RESIDENCIES_PARENT_REPOSITORIES_ID:2}
 gitlab.api/mp-rest/url=${GITLAB_API_URL:https://acmegit.com}
 deployKey=${DEPLOY_KEY:0}
 
+git.commit=${GIT_API_GIT_COMMIT:not.set}
+git.tag=${GIT_API_GIT_TAG:not.set}
+

src/test/java/com/redhat/labs/omp/resource/VersionResourceTest.java

@@ -0,0 +1,23 @@
+package com.redhat.labs.omp.resource;
+
+import static io.restassured.RestAssured.given;
+import static org.hamcrest.CoreMatchers.is;
+
+import org.junit.jupiter.api.Test;
+
+import io.quarkus.test.junit.QuarkusTest;
+
+@QuarkusTest
+public class VersionResourceTest {
+
+    @Test
+    public void testValidResourceVersion() {
+        given()
+        .when()
+            .get("/api/v1/version")
+        .then()
+            .statusCode(200)
+            .body(is("{\"git_commit\":\"not.set\",\"git_tag\":\"not.set\"}"));
+    }   
+}
+