JCU/Expose buildVersion on REST root — serving side (#813) (#1417)

* Expose buildVersion on REST root (serving side of deployed-version info) (#813)

The Docker build already generates dspace/config/VERSION_D.txt (docker.yml +
reusable-docker-build.yml), but nothing exposed it. Add the serving side to match
dtq-dev so /server/api reports which commit is deployed:
- dspace.cfg: build.version.file.path points at the generated file.
- RootConverter reads that file and sets RootRest.buildVersion.
- RootRest gains the buildVersion field (getter/setter, equals/hashCode).
- dspace/config/VERSION_D.txt committed as an empty placeholder (overwritten at build).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* Fix checkstyle import order in RootConverter (java.io before jakarta) (#813)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* Align build.version comment in dspace.cfg with dtq-dev

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Matus Kasak <matus.kasak@dataquest.sk>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

Author: 3 people

dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RootConverter.java

@@ -9,6 +9,10 @@
 
 import static org.dspace.app.util.Util.getSourceVersion;
 
+import java.io.BufferedReader;
+import java.io.FileReader;
+import java.io.IOException;
+
 import jakarta.servlet.http.HttpServletRequest;
 import org.apache.commons.lang3.StringUtils;
 import org.dspace.app.rest.model.RootRest;
@@ -39,8 +43,37 @@ public RootRest convert(HttpServletRequest request) {
             rootRest.setDspaceServer(dspaceUrl);
         }
         rootRest.setDspaceVersion("DSpace " + getSourceVersion());
+        rootRest.setBuildVersion(getBuildVersion());
         return rootRest;
     }
 
+    /**
+     * Read the build version from the `build.version.file.path` property
+     *
+     * @return content of the version file
+     */
+    private String getBuildVersion() {
+        String bVersionFilePath = configurationService.getProperty("build.version.file.path");
+
+        if (StringUtils.isBlank(bVersionFilePath)) {
+            return "Unknown";
+        }
+
+        StringBuilder buildVersion = new StringBuilder();
+        try {
+            FileReader fileReader = new FileReader(bVersionFilePath);
+            BufferedReader bufferedReader = new BufferedReader(fileReader);
 
+            String line;
+            // Read each line from the file until the end of the file is reached
+            while ((line = bufferedReader.readLine()) != null) {
+                buildVersion.append(line);
+            }
+
+        } catch (IOException e) {
+            // Empty - do not log anything
+        }
+
+        return buildVersion.toString();
+    }
 }

dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RootRest.java

@@ -22,6 +22,7 @@ public class RootRest extends RestAddressableModel {
     private String dspaceName;
     private String dspaceServer;
     private String dspaceVersion;
+    private String buildVersion;
 
     public String getCategory() {
         return CATEGORY;
@@ -76,6 +77,14 @@ public void setDspaceVersion(String dspaceVersion) {
         this.dspaceVersion = dspaceVersion;
     }
 
+    public String getBuildVersion() {
+        return buildVersion;
+    }
+
+    public void setBuildVersion(String buildVersion) {
+        this.buildVersion = buildVersion;
+    }
+
     @Override
     public boolean equals(Object object) {
         return (object instanceof RootRest &&
@@ -85,6 +94,7 @@ public boolean equals(Object object) {
                                .append(this.getDspaceUI(), ((RootRest) object).getDspaceUI())
                                .append(this.getDspaceName(), ((RootRest) object).getDspaceName())
                                .append(this.getDspaceServer(), ((RootRest) object).getDspaceServer())
+                               .append(this.getBuildVersion(), ((RootRest) object).getBuildVersion())
                                .isEquals());
     }
 
@@ -97,6 +107,7 @@ public int hashCode() {
             .append(this.getDspaceName())
             .append(this.getDspaceUI())
             .append(this.getDspaceServer())
+            .append(this.getBuildVersion())
             .toHashCode();
     }
 }

dspace/config/VERSION_D.txt

@@ -42,6 +42,9 @@ dspace.ui.url = http://localhost:4000
 dspace.name = DSpace Jihočeské Univerzity v Českých Budějovicích
 dspace.shortname = DSpace
 
+### The build version is stored in the specific file ###
+build.version.file.path = ${dspace.dir}/config/VERSION_D.txt
+
 # Assetstore configurations have moved to config/modules/assetstore.cfg
 # and config/spring/api/bitstore.xml.
 # Additional storage options (e.g. Amazon S3) are available in `assetstore.cfg`