Merge branch 'version' into 'main'

Resolves - Add Version Info

Closes #28

See merge request !112

.gitignore

@@ -19,6 +19,7 @@ libs
 .factorypath
 .apt_*
 .vscode
+*version.json
 
 # Node
 node_modules

.gitlab-ci.yml

@@ -160,7 +160,9 @@ Build Image:
     DOCKER_BUILD_ARGS: |
       BUILD_IMAGE=${DEVOPS_REGISTRY}usgs/amazoncorretto:11
       FROM_IMAGE=${DEVOPS_REGISTRY}usgs/amazoncorretto:11
+      CI_COMMIT_BRANCH=${CI_COMMIT_BRANCH}
       CI_JOB_TOKEN=${CI_JOB_TOKEN}
+      CI_PROJECT_URL=${CI_PROJECT_URL}
     UPSTREAM_PATH: ghsc/nshmp/nshmp-ws-static
 
 Build Project:

Dockerfile

@@ -13,6 +13,8 @@ FROM ${BUILD_IMAGE} as builder
 # TODO: Token needed until nshmp-lib is public
 ARG GITLAB_TOKEN=null
 ARG CI_JOB_TOKEN=null
+ARG CI_PROJECT_URL=null
+ARG CI_COMMIT_BRANCH=null
 
 WORKDIR /app
 

build.gradle

@@ -3,6 +3,7 @@ plugins {
   id "com.github.johnrengelman.shadow" version "${shadowVersion}"
   id "com.github.node-gradle.node" version "${nodePluginVersion}"
   id "com.github.spotbugs" version "${spotbugsVersion}"
+  id "com.palantir.git-version" version "${gitVersionVersion}"
   id "com.star-zero.gradle.githook" version "${githooksVersion}"
   id "eclipse-wtp"
   id "jacoco"
@@ -26,6 +27,7 @@ subprojects {
   apply plugin: "com.github.johnrengelman.shadow"
   apply plugin: "com.github.node-gradle.node"
   apply plugin: "com.github.spotbugs"
+  apply plugin: "com.palantir.git-version"
   apply plugin: "com.star-zero.gradle.githook"
   apply plugin: "com.github.johnrengelman.shadow"
   apply plugin: "eclipse-wtp"
@@ -41,6 +43,7 @@ subprojects {
   sourceCompatibility = JavaVersion.VERSION_11
   targetCompatibility = JavaVersion.VERSION_11
 
+  apply from: "${rootDir}/gradle/app-version.gradle"
   apply from: "${rootDir}/gradle/dependencies.gradle"
   apply from: "${rootDir}/gradle/git-hooks.gradle"
   apply from: "${rootDir}/gradle/repositories.gradle"

gradle.properties

 githooksVersion = 1.2.0
+gitVersionVersion = 0.15.0
 jacksonVersion = 2.9.0
 junitVersion = 5.8.2
 micronautVersion = 3.2.3
@@ -6,8 +7,8 @@ micronautRxVersion = 2.1.1
 netcdfVersion = 5.5.2
 nodePluginVersion = 3.0.1
 nodeVersion = 16.3.0
-nshmpLibVersion = 0.8.2
-nshmpWsUtilsVersion = 0.3.4
+nshmpLibVersion = 1.0.6
+nshmpWsUtilsVersion = 0.3.7
 openApiVersion = 4.0.0
 shadowVersion = 7.1.1
 slfVersion = 1.7.30

gradle/app-version.gradle

+apply plugin: "com.palantir.git-version"
+
+tasks.withType(JavaCompile) {
+  doFirst {
+    def versionFile = new File("${projectDir}/src/main/resources/version/nshmp-ws-static-version.json")
+    new File(versionFile.getParent()).mkdirs()
+    def details = versionDetails()
+    def ciProjectUrl = System.getenv("CI_PROJECT_URL")
+    def branch = System.getenv("CI_COMMIT_BRANCH")
+    def versionInfo = [
+      branchName: branch ? branch : details.branchName,
+      commitDistance: details.commitDistance,
+      gitHash:  details.gitHash,
+      gitHashFull:  details.gitHashFull,
+      isCleanTag:  details.isCleanTag,
+      lastTag:  details.lastTag,
+      projectName: rootProject.name,
+      url: ciProjectUrl ? ciProjectUrl : 'git config --get remote.origin.url'.execute().text.replace('\n', ''),
+      version: details.version,
+    ]
+    def json = groovy.json.JsonOutput.toJson(versionInfo)
+    versionFile.write(groovy.json.JsonOutput.prettyPrint(json))
+  }
+}

gradle/spotless.gradle

@@ -59,7 +59,8 @@ spotless {
     target fileTree(".") {
       include "**/*.xml"
       exclude "**/build", ".settings", ".classpath", ".project",
-          "tmp", ".gradle", "libs", "node_modules", "**/.gradle", "bin", "**/bin"
+          "tmp", ".gradle", "libs", "node_modules", "**/.gradle",
+          "bin", "**/bin", "**/.settings"
     }
     eclipseWtp("xml")
     trimTrailingWhitespace()

src/aashto/src/main/java/gov/usgs/earthquake/nshmp/netcdf/www/NetcdfController.java

@@ -6,7 +6,7 @@ import gov.usgs.earthquake.nshmp.gmm.NehrpSiteClass;
 import gov.usgs.earthquake.nshmp.netcdf.NetcdfGroundMotions;
 import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfService.RequestDataSiteClass;
 import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfService.ResponseData;
-import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfService.ResponseMetadata;
+import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfService.ServiceResponseMetadata;
 import gov.usgs.earthquake.nshmp.www.NshmpMicronautServlet;
 import gov.usgs.earthquake.nshmp.www.ResponseBody;
 
@@ -152,5 +152,5 @@ public class NetcdfController {
   // For Swagger schema
   private static class Response
       extends
-      ResponseBody<RequestDataSiteClass, ResponseData<ResponseMetadata>> {}
+      ResponseBody<RequestDataSiteClass, ResponseData<ServiceResponseMetadata>> {}
 }

src/aashto/src/main/java/gov/usgs/earthquake/nshmp/netcdf/www/NetcdfServiceGroundMotions.java

@@ -6,10 +6,12 @@ import java.util.stream.Collectors;
 import gov.usgs.earthquake.nshmp.data.XySequence;
 import gov.usgs.earthquake.nshmp.geo.Location;
 import gov.usgs.earthquake.nshmp.netcdf.NetcdfGroundMotions;
+import gov.usgs.earthquake.nshmp.netcdf.NetcdfVersion;
 import gov.usgs.earthquake.nshmp.netcdf.data.StaticData;
 import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfWsUtils.Key;
 import gov.usgs.earthquake.nshmp.netcdf.www.Query.Service;
 import gov.usgs.earthquake.nshmp.www.ResponseBody;
+import gov.usgs.earthquake.nshmp.www.ResponseMetadata;
 import gov.usgs.earthquake.nshmp.www.WsUtils;
 
 import io.micronaut.http.HttpRequest;
@@ -37,6 +39,7 @@ public class NetcdfServiceGroundMotions extends NetcdfService<Query> {
     var metadata = new Metadata(request, SERVICE_DESCRIPTION);
 
     return ResponseBody.<String, Metadata> usage()
+        .metadata(new ResponseMetadata(NetcdfVersion.appVersions()))
         .name(SERVICE_NAME)
         .request(NetcdfWsUtils.getRequestUrl(request))
         .response(metadata)
@@ -78,7 +81,7 @@ public class NetcdfServiceGroundMotions extends NetcdfService<Query> {
   }
 
   @Override
-  ResponseBody<RequestDataSiteClass, ResponseData<ResponseMetadata>> processCurvesSiteClass(
+  ResponseBody<RequestDataSiteClass, ResponseData<ServiceResponseMetadata>> processCurvesSiteClass(
       RequestDataSiteClass request,
       String url) {
     WsUtils.checkValue(Key.LATITUDE, request.latitude);
@@ -87,7 +90,8 @@ public class NetcdfServiceGroundMotions extends NetcdfService<Query> {
     var curves = netcdf().staticData(request.site, request.siteClass);
     var responseData = toResponseData(request, curves);
 
-    return ResponseBody.<RequestDataSiteClass, ResponseData<ResponseMetadata>> success()
+    return ResponseBody.<RequestDataSiteClass, ResponseData<ServiceResponseMetadata>> success()
+        .metadata(new ResponseMetadata(NetcdfVersion.appVersions()))
         .name(SERVICE_NAME)
         .request(request)
         .response(responseData)
@@ -96,7 +100,7 @@ public class NetcdfServiceGroundMotions extends NetcdfService<Query> {
   }
 
   @Override
-  ResponseBody<RequestData, List<ResponseData<ResponseMetadata>>> processCurves(
+  ResponseBody<RequestData, List<ResponseData<ServiceResponseMetadata>>> processCurves(
       RequestData request,
       String url) {
     WsUtils.checkValue(Key.LATITUDE, request.latitude);
@@ -104,7 +108,8 @@ public class NetcdfServiceGroundMotions extends NetcdfService<Query> {
     var curves = netcdf().staticData(request.site);
     var responseData = toList(request.site, curves);
 
-    return ResponseBody.<RequestData, List<ResponseData<ResponseMetadata>>> success()
+    return ResponseBody.<RequestData, List<ResponseData<ServiceResponseMetadata>>> success()
+        .metadata(new ResponseMetadata(NetcdfVersion.appVersions()))
         .name(SERVICE_NAME)
         .request(request)
         .response(responseData)
@@ -112,7 +117,7 @@ public class NetcdfServiceGroundMotions extends NetcdfService<Query> {
         .build();
   }
 
-  List<ResponseData<ResponseMetadata>> toList(
+  List<ResponseData<ServiceResponseMetadata>> toList(
       Location site,
       StaticData<XySequence> curves) {
     return curves.entrySet().stream()
@@ -123,10 +128,10 @@ public class NetcdfServiceGroundMotions extends NetcdfService<Query> {
         .collect(Collectors.toList());
   }
 
-  ResponseData<ResponseMetadata> toResponseData(
+  ResponseData<ServiceResponseMetadata> toResponseData(
       RequestDataSiteClass request,
       XySequence curves) {
-    var metadata = new ResponseMetadata(
+    var metadata = new ServiceResponseMetadata(
         request.siteClass,
         X_LABEL,
         Y_LABEL);

src/hazard/src/main/java/gov/usgs/earthquake/nshmp/netcdf/www/NetcdfServiceHazardCurves.java

@@ -8,11 +8,13 @@ import gov.usgs.earthquake.nshmp.geo.Location;
 import gov.usgs.earthquake.nshmp.gmm.Imt;
 import gov.usgs.earthquake.nshmp.gmm.NehrpSiteClass;
 import gov.usgs.earthquake.nshmp.netcdf.NetcdfHazardCurves;
+import gov.usgs.earthquake.nshmp.netcdf.NetcdfVersion;
 import gov.usgs.earthquake.nshmp.netcdf.data.StaticData;
 import gov.usgs.earthquake.nshmp.netcdf.data.StaticDataHazardCurves;
 import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfWsUtils.Key;
 import gov.usgs.earthquake.nshmp.netcdf.www.Query.Service;
 import gov.usgs.earthquake.nshmp.www.ResponseBody;
+import gov.usgs.earthquake.nshmp.www.ResponseMetadata;
 import gov.usgs.earthquake.nshmp.www.WsUtils;
 
 import io.micronaut.http.HttpRequest;
@@ -39,6 +41,7 @@ public class NetcdfServiceHazardCurves extends NetcdfService<HazardQuery> {
   ResponseBody<String, Metadata> getMetadataResponse(HttpRequest<?> request) {
     var metadata = new Metadata(request, SERVICE_DESCRIPTION);
     return ResponseBody.<String, Metadata> usage()
+        .metadata(new ResponseMetadata(NetcdfVersion.appVersions()))
         .name(SERVICE_NAME)
         .request(NetcdfWsUtils.getRequestUrl(request))
         .response(metadata)
@@ -82,6 +85,7 @@ public class NetcdfServiceHazardCurves extends NetcdfService<HazardQuery> {
     var curvesAsList = toList(request.site, curves);
 
     return ResponseBody.<RequestData, List<List<ResponseData<HazardResponseMetadata>>>> success()
+        .metadata(new ResponseMetadata(NetcdfVersion.appVersions()))
         .name(SERVICE_NAME)
         .request(request)
         .response(curvesAsList)
@@ -100,6 +104,7 @@ public class NetcdfServiceHazardCurves extends NetcdfService<HazardQuery> {
     var curvesAsList = toList(request, curves);
 
     return ResponseBody.<RequestDataSiteClass, List<ResponseData<HazardResponseMetadata>>> success()
+        .metadata(new ResponseMetadata(NetcdfVersion.appVersions()))
         .name(SERVICE_NAME)
         .request(request)
         .response(curvesAsList)
@@ -117,6 +122,7 @@ public class NetcdfServiceHazardCurves extends NetcdfService<HazardQuery> {
     var curves = netcdf().staticData(request.site, request.siteClass);
 
     return ResponseBody.<RequestDataSiteClass, ResponseData<HazardResponseMetadata>> success()
+        .metadata(new ResponseMetadata(NetcdfVersion.appVersions()))
         .name(SERVICE_NAME)
         .request(request)
         .response(toResponseData(request, request.imt, curves.get(request.imt)))
@@ -182,7 +188,7 @@ public class NetcdfServiceHazardCurves extends NetcdfService<HazardQuery> {
     }
   }
 
-  static class HazardResponseMetadata extends ResponseMetadata {
+  static class HazardResponseMetadata extends ServiceResponseMetadata {
     public final Imt imt;
 
     HazardResponseMetadata(NehrpSiteClass siteClass, Imt imt, String xLabel, String yLabel) {

src/lib/src/main/java/gov/usgs/earthquake/nshmp/netcdf/NetcdfVersion.java

+package gov.usgs.earthquake.nshmp.netcdf;
+
+import com.google.common.io.Resources;
+
+import gov.usgs.earthquake.nshmp.internal.AppVersion;
+import gov.usgs.earthquake.nshmp.internal.LibVersion;
+import gov.usgs.earthquake.nshmp.www.WsUtilsVersion;
+
+public class NetcdfVersion implements AppVersion {
+
+  public static VersionInfo[] appVersions() {
+    VersionInfo[] versions = {
+        new NetcdfVersion().getVersionInfo(),
+        new LibVersion().getVersionInfo(),
+        new WsUtilsVersion().getVersionInfo(),
+    };
+    return versions;
+  }
+
+  public VersionInfo getVersionInfo() {
+    var resource = Resources.getResource("version/nshmp-ws-static-version.json");
+    return AppVersion.versionInfo(resource);
+  }
+}

src/lib/src/main/java/gov/usgs/earthquake/nshmp/netcdf/www/NetcdfService.java

@@ -197,12 +197,12 @@ public abstract class NetcdfService<T extends Query> {
     }
   }
 
-  static class ResponseMetadata {
+  static class ServiceResponseMetadata {
     public NehrpSiteClass siteClass;
     public String xLabel;
     public String yLabel;
 
-    ResponseMetadata(
+    ServiceResponseMetadata(
         NehrpSiteClass siteClass,
         String xLabel,
         String yLabel) {
@@ -212,7 +212,7 @@ public abstract class NetcdfService<T extends Query> {
     }
   }
 
-  static class ResponseData<T extends ResponseMetadata> {
+  static class ResponseData<T extends ServiceResponseMetadata> {
     final T metadata;
     final XySequence data;
 

src/lib/src/main/java/gov/usgs/earthquake/nshmp/netcdf/www/NetcdfWsUtils.java

@@ -13,9 +13,11 @@ import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 
 import gov.usgs.earthquake.nshmp.gmm.Imt;
+import gov.usgs.earthquake.nshmp.netcdf.NetcdfVersion;
 import gov.usgs.earthquake.nshmp.netcdf.data.NetcdfData;
 import gov.usgs.earthquake.nshmp.netcdf.data.ScienceBaseMetadata;
 import gov.usgs.earthquake.nshmp.www.ResponseBody;
+import gov.usgs.earthquake.nshmp.www.ResponseMetadata;
 import gov.usgs.earthquake.nshmp.www.SwaggerUtils;
 import gov.usgs.earthquake.nshmp.www.WsUtils.EnumSerializer;
 import gov.usgs.earthquake.nshmp.www.WsUtils.NaNSerializer;
@@ -55,6 +57,7 @@ public class NetcdfWsUtils {
       String url) {
     var msg = e.getMessage() + " (see logs)";
     var svcResponse = ResponseBody.error()
+        .metadata(new ResponseMetadata(NetcdfVersion.appVersions()))
         .name(name)
         .request(url)
         .response(msg)