Stricter determination of whether build is on CI. The CTHING_CI environment variable must not only be defined, it must now have the value "true" (case-insensitive) to indicate a CI build. Added an isCIBuild method to complement the existing isDeveloperBuild method.

baron1405 · baron1405 · commit 66736c90eb3e · 2025-10-21T23:39:11.000-07:00
diff --git a/README.md b/README.md
@@ -9,12 +9,14 @@ information. The additional information indicates the build type and whether the
 C Thing Software Continuous Integration service or on a developer's machine. The following versioning scheme is
 used:
 
-| Build Environment                          | Requested Build Type | Actual Build Type | Semantic Version                  |
-|--------------------------------------------|----------------------|-------------------|-----------------------------------|
-| CTHING_CI undefined (i.e. developer build) | snapshot             | snapshot          | n.n.n-0                           |
-| CTHING_CI defined (i.e. CI build)          | snapshot             | snapshot          | n.n.n-t (t = ms since Unix Epoch) |
-| CTHING_CI undefined                        | release              | snapshot          | n.n.n-0                           |
-| CTHING_CI defined                          | release              | release           | n.n.n                             |
+| Build Environment                                                  | Requested Build Type | Actual Build Type | Semantic Version                  |
+|--------------------------------------------------------------------|----------------------|-------------------|-----------------------------------|
+| CTHING_CI == false<sup>1</sup> or undefined (i.e. developer build) | snapshot             | snapshot          | n.n.n-0                           |
+| CTHING_CI == true (i.e. CI build)                                  | snapshot             | snapshot          | n.n.n-t (t = ms since Unix Epoch) |
+| CTHING_CI == false or undefined                                    | release              | snapshot          | n.n.n-0                           |
+| CTHING_CI == true                                                  | release              | release           | n.n.n                             |
+
+<sup>1</sup>The values `true` and `false` are case-insensitive
 
 ## Usage
 The library is available from [Maven Central](https://repo.maven.apache.org/maven2/org/cthing/cthing-projectversion/) using
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -22,10 +22,10 @@ plugins {
     alias(libs.plugins.versions)
 }
 
-val baseVersion = "2.0.1"
+val baseVersion = "3.0.0"
 val isSnapshot = true
 
-val isCIServer = System.getenv("CTHING_CI") != null
+val isCIServer = "true" == System.getenv("CTHING_CI")?.lowercase()
 val now = System.currentTimeMillis()
 val buildNumber = if (isCIServer) now.toString() else "0"
 val buildDate: String = Instant.ofEpochMilli(now)
diff --git a/src/main/java/org/cthing/projectversion/ProjectVersion.java b/src/main/java/org/cthing/projectversion/ProjectVersion.java
@@ -10,6 +10,7 @@
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.Date;
+import java.util.Locale;
 import java.util.Objects;
 import java.util.TimeZone;
 import java.util.regex.Matcher;
@@ -35,32 +36,36 @@
  *     </thead>
  *     <tbody>
  *         <tr>
- *             <td style="text-align: left; padding: 5px;">CTHING_CI defined (i.e. CI build)</td>
+ *             <td style="text-align: left; padding: 5px;">CTHING_CI == true<sup>1</sup> (i.e. CI build)</td>
  *             <td style="text-align: left; padding: 5px;">snapshot</td>
  *             <td style="text-align: left; padding: 5px;">snapshot</td>
  *             <td style="text-align: left; padding: 5px;">n.n.n-t (t = ms since Unix Epoch)</td>
  *         </tr>
  *         <tr>
- *             <td style="text-align: left; padding: 5px;">CTHING_CI undefined (i.e. developer build)</td>
+ *             <td style="text-align: left; padding: 5px;">CTHING_CI == false or undefined (i.e. developer build)</td>
  *             <td style="text-align: left; padding: 5px;">snapshot</td>
  *             <td style="text-align: left; padding: 5px;">snapshot</td>
  *             <td style="text-align: left; padding: 5px;">n.n.n-0</td>
  *         </tr>
  *         <tr>
- *             <td style="text-align: left; padding: 5px;">CTHING_CI defined</td>
+ *             <td style="text-align: left; padding: 5px;">CTHING_CI == true</td>
  *             <td style="text-align: left; padding: 5px;">release</td>
  *             <td style="text-align: left; padding: 5px;">release</td>
  *             <td style="text-align: left; padding: 5px;">n.n.n</td>
  *         </tr>
  *         <tr>
- *             <td style="text-align: left; padding: 5px;">CTHING_CI undefined</td>
+ *             <td style="text-align: left; padding: 5px;">CTHING_CI == false or undefined</td>
  *             <td style="text-align: left; padding: 5px;">release</td>
  *             <td style="text-align: left; padding: 5px;">snapshot</td>
  *             <td style="text-align: left; padding: 5px;">n.n.n-0</td>
  *         </tr>
  *     </tbody>
  * </table>
  *
+ * <p>
+ *     <sup>1</sup>The values {@code true} and {@code false} are case-insensitive
+ * </p>
+ *
  * @see "http://semver.org/"
  */
 public final class ProjectVersion implements Comparable<ProjectVersion>, Serializable {
@@ -239,6 +244,8 @@ public String getBuildNumber() {
      * Obtains the type of the build represented by this version.
      *
      * @return Build type
+     * @see #isReleaseBuild()
+     * @see #isSnapshotBuild()
      */
     public BuildType getBuildType() {
         return this.buildType;
@@ -248,6 +255,8 @@ public BuildType getBuildType() {
      * Indicates whether this version represents a release build.
      *
      * @return {@code true} if this version represents a release build.
+     * @see #getBuildType()
+     * @see #isSnapshotBuild()
      */
     public boolean isReleaseBuild() {
         return this.buildType == BuildType.release;
@@ -257,19 +266,34 @@ public boolean isReleaseBuild() {
      * Indicates whether this version represents a snapshot build.
      *
      * @return {@code true} if this version represents a snapshot build.
+     * @see #getBuildType()
+     * @see #isReleaseBuild()
      */
     public boolean isSnapshotBuild() {
         return this.buildType == BuildType.snapshot;
     }
 
     /**
      * Indicates whether the version represents a build taking place on a developer's machine.
+     * This method is the inverse of {@link #isCIBuild()}.
      *
      * @return {@code true} if the build is taking place on a developer's machine.
+     * @see #isCIBuild()
      */
     public static boolean isDeveloperBuild() {
         final String cthingCI = System.getenv("CTHING_CI");
-        return cthingCI == null || cthingCI.isBlank();
+        return cthingCI == null || !"true".equals(cthingCI.toLowerCase(Locale.ENGLISH));
+    }
+
+    /**
+     * Indicates whether the version represents a build taking place on the Continuous Integration (CI) system.
+     * This method is the inverse of {@link #isDeveloperBuild()}.
+     *
+     * @return {@code true} if the build is taking place on the CI system.
+     * @see #isDeveloperBuild()
+     */
+    public static boolean isCIBuild() {
+        return !isDeveloperBuild();
     }
 
     /**
diff --git a/src/test/java/org/cthing/projectversion/ProjectVersionTest.java b/src/test/java/org/cthing/projectversion/ProjectVersionTest.java
@@ -34,6 +34,7 @@ public void testSnapshotDeveloperVersion() throws Exception {
                     final ProjectVersion version = new ProjectVersion("1.2.3", BuildType.snapshot);
 
                     assertThat(ProjectVersion.isDeveloperBuild()).isTrue();
+                    assertThat(ProjectVersion.isCIBuild()).isFalse();
                     assertThat(version.getMajorVersion()).isEqualTo(1);
                     assertThat(version.getMinorVersion()).isEqualTo(2);
                     assertThat(version.getPatchVersion()).isEqualTo(3);
@@ -56,6 +57,30 @@ public void testSnapshotDeveloperVersion() throws Exception {
                     final ProjectVersion version = new ProjectVersion("1.2.3", BuildType.snapshot);
 
                     assertThat(ProjectVersion.isDeveloperBuild()).isTrue();
+                    assertThat(ProjectVersion.isCIBuild()).isFalse();
+                    assertThat(version.getMajorVersion()).isEqualTo(1);
+                    assertThat(version.getMinorVersion()).isEqualTo(2);
+                    assertThat(version.getPatchVersion()).isEqualTo(3);
+                    assertThat(version.getSemanticVersion()).isEqualTo("1.2.3-0");
+                    assertThat(version.getCoreVersion()).isEqualTo("1.2.3");
+                    assertThat(version.getBuildNumber()).isEqualTo("0");
+                    assertThat(version.getBuildType()).isEqualTo(BuildType.snapshot);
+                    assertThat(version.isReleaseBuild()).isFalse();
+                    assertThat(version.isSnapshotBuild()).isTrue();
+                    assertThat(version.getBuildDate()).matches("^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$");
+                    assertThat(version.getBuildDateMillis()).isGreaterThan(0L);
+                    assertThat(version.getBranch()).isEqualTo("unknown");
+                    assertThat(version.getCommit()).isEqualTo("unknown");
+                    assertThat(version.toString()).isEqualTo("1.2.3-0");
+                });
+        withEnvironmentVariable("CTHING_CI", "false")
+                .and("GIT_BRANCH", "")
+                .and("GIT_COMMIT", "  ")
+                .execute(() -> {
+                    final ProjectVersion version = new ProjectVersion("1.2.3", BuildType.snapshot);
+
+                    assertThat(ProjectVersion.isDeveloperBuild()).isTrue();
+                    assertThat(ProjectVersion.isCIBuild()).isFalse();
                     assertThat(version.getMajorVersion()).isEqualTo(1);
                     assertThat(version.getMinorVersion()).isEqualTo(2);
                     assertThat(version.getPatchVersion()).isEqualTo(3);
@@ -82,6 +107,30 @@ public void testSnapshotCIVersion() throws Exception {
                     final ProjectVersion version = new ProjectVersion("1.2.3", BuildType.snapshot);
 
                     assertThat(ProjectVersion.isDeveloperBuild()).isFalse();
+                    assertThat(ProjectVersion.isCIBuild()).isTrue();
+                    assertThat(version.getMajorVersion()).isEqualTo(1);
+                    assertThat(version.getMinorVersion()).isEqualTo(2);
+                    assertThat(version.getPatchVersion()).isEqualTo(3);
+                    assertThat(version.getSemanticVersion()).matches("1\\.2\\.3-\\d{2,}");
+                    assertThat(version.getCoreVersion()).isEqualTo("1.2.3");
+                    assertThat(version.getBuildNumber()).isNotEqualTo("0");
+                    assertThat(version.getBuildType()).isEqualTo(BuildType.snapshot);
+                    assertThat(version.isReleaseBuild()).isFalse();
+                    assertThat(version.isSnapshotBuild()).isTrue();
+                    assertThat(version.getBuildDate()).matches("^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$");
+                    assertThat(version.getBuildDateMillis()).isGreaterThan(0L);
+                    assertThat(version.getBranch()).isEqualTo("master");
+                    assertThat(version.getCommit()).isEqualTo("a5b7f46");
+                    assertThat(version.toString()).matches("1\\.2\\.3-\\d{2,}");
+                });
+        withEnvironmentVariable("CTHING_CI", "TRUE")
+                .and("GIT_BRANCH", "master")
+                .and("GIT_COMMIT", "a5b7f46")
+                .execute(() -> {
+                    final ProjectVersion version = new ProjectVersion("1.2.3", BuildType.snapshot);
+
+                    assertThat(ProjectVersion.isDeveloperBuild()).isFalse();
+                    assertThat(ProjectVersion.isCIBuild()).isTrue();
                     assertThat(version.getMajorVersion()).isEqualTo(1);
                     assertThat(version.getMinorVersion()).isEqualTo(2);
                     assertThat(version.getPatchVersion()).isEqualTo(3);
@@ -108,6 +157,7 @@ public void testReleaseDeveloperVersion() throws Exception {
                     final ProjectVersion version = new ProjectVersion("1.2.3", BuildType.release);
 
                     assertThat(ProjectVersion.isDeveloperBuild()).isTrue();
+                    assertThat(ProjectVersion.isCIBuild()).isFalse();
                     assertThat(version.getMajorVersion()).isEqualTo(1);
                     assertThat(version.getMinorVersion()).isEqualTo(2);
                     assertThat(version.getPatchVersion()).isEqualTo(3);
@@ -134,6 +184,7 @@ public void testReleaseCIVersion() throws Exception {
                     final ProjectVersion version = new ProjectVersion("1.2.3", BuildType.release);
 
                     assertThat(ProjectVersion.isDeveloperBuild()).isFalse();
+                    assertThat(ProjectVersion.isCIBuild()).isTrue();
                     assertThat(version.getMajorVersion()).isEqualTo(1);
                     assertThat(version.getMinorVersion()).isEqualTo(2);
                     assertThat(version.getPatchVersion()).isEqualTo(3);
@@ -200,7 +251,7 @@ public void testSerialize() throws Exception {
 
     @Test
     public void testOrder() throws Exception {
-        withEnvironmentVariable("CTHING_CI", "true")
+        withEnvironmentVariable("CTHING_CI", "True")
                 .and("GIT_BRANCH", "master")
                 .and("GIT_COMMIT", "a5b7f46")
                 .execute(() -> {
