Merge pull request #618 from iExecBlockchainComputing/bugfix/clean-version-service

Remove `VersionService#isSnapshot`

Author: jbern0rd

CHANGELOG.md

@@ -19,6 +19,7 @@ All notable changes to this project will be documented in this file.
 - Events are now immutable with `@Value` lombok annotation. (#608)
 - Fix several code smells. (#609)
 - Upgrade to Gradle 8.2.1 with up-to-date plugins. (#612)
+- Remove `VersionService#isSnapshot`. (#618)
 ### Dependency Upgrades
 - Remove `logstash-gelf` dependency. (#607)
 - Upgrade to `eclipse-temurin` 11.0.20. (#610)

src/main/java/com/iexec/core/config/OpenApiConfig.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
 
 package com.iexec.core.config;
 
-import com.iexec.core.utils.version.VersionService;
+import com.iexec.core.version.VersionService;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Info;
 import org.springframework.context.annotation.Bean;

…ore/utils/version/VersionController.java …exec/core/version/VersionController.javasrc/main/java/com/iexec/core/utils/version/VersionController.java renamed to src/main/java/com/iexec/core/version/VersionController.java src/main/java/com/iexec/core/utils/version/VersionController.java renamed to src/main/java/com/iexec/core/version/VersionController.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package com.iexec.core.utils.version;
+package com.iexec.core.version;
 
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;

…c/core/utils/version/VersionService.java …m/iexec/core/version/VersionService.javasrc/main/java/com/iexec/core/utils/version/VersionService.java renamed to src/main/java/com/iexec/core/version/VersionService.java src/main/java/com/iexec/core/utils/version/VersionService.java renamed to src/main/java/com/iexec/core/version/VersionService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,9 +14,8 @@
  * limitations under the License.
  */
 
-package com.iexec.core.utils.version;
+package com.iexec.core.version;
 
-import com.iexec.common.utils.VersionUtils;
 import org.springframework.boot.info.BuildProperties;
 import org.springframework.stereotype.Service;
 
@@ -33,8 +32,4 @@ public String getVersion() {
         return buildProperties.getVersion();
     }
 
-    public boolean isSnapshot() {
-        return VersionUtils.isSnapshot(buildProperties.getVersion());
-    }
-
 }

src/test/java/com/iexec/core/version/VersionControllerTests.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.iexec.core.version;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.springframework.http.ResponseEntity;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.Mockito.when;
+
+class VersionControllerTests {
+    @Mock
+    private VersionService versionService;
+    @InjectMocks
+    private VersionController versionController;
+
+    @BeforeEach
+    void init() {
+        MockitoAnnotations.openMocks(this);
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings={"x.y.z", "x.y.z-rc", "x.y.z-NEXT-SNAPSHOT"})
+    void testVersionController(String version) {
+        when(versionService.getVersion()).thenReturn(version);
+        assertEquals(ResponseEntity.ok(version), versionController.getVersion());
+    }
+}

…e/utils/version/VersionServiceTests.java …ec/core/version/VersionServiceTests.javasrc/test/java/com/iexec/core/utils/version/VersionServiceTests.java renamed to src/test/java/com/iexec/core/version/VersionServiceTests.java src/test/java/com/iexec/core/utils/version/VersionServiceTests.java renamed to src/test/java/com/iexec/core/version/VersionServiceTests.java

@@ -1,4 +1,20 @@
-package com.iexec.core.utils.version;
+/*
+ * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.iexec.core.version;
 
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
@@ -25,18 +41,10 @@ public void preflight() {
     }
 
     @ParameterizedTest
-    @ValueSource(strings={"x.y.z", "x.y.z-rc"})
-    void testNonSnapshotVersion(String version) {
+    @ValueSource(strings={"x.y.z", "x.y.z-rc", "x.y.z-NEXT-SNAPSHOT"})
+    void testVersions(String version) {
         Mockito.when(buildProperties.getVersion()).thenReturn(version);
         Assertions.assertEquals(version, versionService.getVersion());
-        Assertions.assertFalse(versionService.isSnapshot());
-    }
-
-    @Test
-    void testSnapshotVersion() {
-        Mockito.when(buildProperties.getVersion()).thenReturn("x.y.z-NEXT-SNAPSHOT");
-        Assertions.assertEquals("x.y.z-NEXT-SNAPSHOT", versionService.getVersion());
-        Assertions.assertTrue(versionService.isSnapshot());
     }
 
 }