Merge branch 'release/7.1.0'

Author: jbern0rd

.gitignore

@@ -1,5 +1,5 @@
 .gradle
-/build/
+build
 bin/
 
 # Ignore Gradle GUI config
@@ -15,7 +15,6 @@ gradle-app.setting
 # gradle/wrapper/gradle-wrapper.properties
 
 HELP.md
-.gradle
 build/
 !gradle/wrapper/gradle-wrapper.jar
 !**/src/main/**

Dockerfile

@@ -1,10 +1,10 @@
-FROM openjdk:11.0.3-jre-slim
+FROM openjdk:11.0.15-jre-slim
 
-ARG spring_boot_jar
+ARG jar
 
-RUN test -n "$spring_boot_jar"
+RUN test -n "$jar"
 
-COPY $spring_boot_jar iexec-result-proxy.jar
+COPY $jar iexec-result-proxy.jar
 
 # For Spring-Boot project, use the entrypoint
 # below to reduce Tomcat startup time.

Jenkinsfile

@@ -1,11 +1,11 @@
-@Library('global-jenkins-library@1.3.0') _
+@Library('global-jenkins-library@2.0.1') _
 buildJavaProject(
+        buildInfo: getBuildInfo(),
         integrationTestsEnvVars: [],
         shouldPublishJars: true,
         shouldPublishDockerImages: true,
         dockerfileDir: '.',
-        //dockerfileFilename: "Dockerfile-local",
-        buildContext: '.',
-        //dockerImageRepositoryName: '',
+        preDevelopVisibility: 'iex.ec',
+        developVisibility: 'iex.ec',
         preProductionVisibility: 'docker.io',
         productionVisibility: 'docker.io')

build.gradle

@@ -1,25 +1,36 @@
 plugins {
     id 'java'
-    id 'org.springframework.boot' version '2.2.5.RELEASE'
+    id 'org.springframework.boot' version '2.6.2'
     id 'io.spring.dependency-management' version '1.0.9.RELEASE'
     id 'eclipse'
     id 'jacoco'
     id 'org.sonarqube' version '3.3'
     id 'maven-publish'
 }
 
-group = 'com.iexec.result-proxy'
-sourceCompatibility = 11
-targetCompatibility = 11
+ext {
+    springCloudVersion = '2021.0.0'
+    gitBranch = 'git rev-parse --abbrev-ref HEAD'.execute().text.trim()
+}
+
+allprojects {
+    group = 'com.iexec.result-proxy'
+    sourceCompatibility = 11
+    targetCompatibility = 11
 
-repositories {
-    mavenLocal()
-    mavenCentral()
-    maven {
-        url 'https://nexus.iex.ec/repository/maven-public/'
+    if (gitBranch != 'main' && gitBranch != 'master' && !(gitBranch ==~ '(release|hotfix|support)/.*')) {
+        version += '-NEXT-SNAPSHOT'
     }
-    maven {
-        url 'https://jitpack.io'
+
+    repositories {
+        mavenLocal()
+        mavenCentral()
+        maven {
+            url 'https://nexus.intra.iex.ec/repository/maven-public/'
+        }
+        maven {
+            url 'https://jitpack.io'
+        }
     }
 }
 
@@ -29,10 +40,6 @@ configurations {
     }
 }
 
-ext {
-    set('springCloudVersion', 'Hoxton.SR3')
-}
-
 dependencies {
     // iexec
     implementation "com.iexec.common:iexec-common:${iexecCommonVersion}"
@@ -45,6 +52,7 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
     implementation 'org.springframework.boot:spring-boot-starter-web'
     implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'
+    implementation "org.springframework.retry:spring-retry"
 
     // test
     testImplementation('org.springframework.boot:spring-boot-starter-test') {
@@ -57,9 +65,8 @@ dependencies {
     compileOnly 'org.projectlombok:lombok'
     annotationProcessor 'org.projectlombok:lombok'
 
-    // swagger
-    implementation 'io.springfox:springfox-swagger2:2.9.2'
-    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
+    // Spring Doc
+    implementation 'org.springdoc:springdoc-openapi-ui:1.6.3'
 
     // ipfs
     implementation 'com.github.ipfs:java-ipfs-http-client:1.3.3'
@@ -77,6 +84,10 @@ dependencyManagement {
     }
 }
 
+springBoot {
+    buildInfo()
+}
+
 test {
     useJUnitPlatform()
 }
@@ -100,21 +111,6 @@ jacocoTestReport {
 tasks.test.finalizedBy    tasks.jacocoTestReport
 tasks.sonarqube.dependsOn tasks.jacocoTestReport
 
-// ######################
-// #   create version   #
-// ######################
-
-task createVersion (type: Exec) {
-    description 'Set version in application.yml'
-    commandLine('sh', '-c', "sed -i 's/^version.*/version: ${version}/' src/main/resources/application.yml")
-}
-
-compileJava.dependsOn createVersion
-
-// ######################
-// #   upload archive   #
-// ######################
-
 publishing {
     publications {
         maven(MavenPublication) {
@@ -133,14 +129,14 @@ publishing {
     }
 }
 
-ext.bootJarPath    = relativePath(tasks.bootJar.outputs.files.singleFile)
+ext.jarPathForOCI  = relativePath(tasks.bootJar.outputs.files.singleFile)
 ext.gitShortCommit = 'git rev-parse --short=8 HEAD'.execute().text.trim()
 ext.ociImageName   = 'local/' + ['bash', '-c', 'basename $(git config --get remote.origin.url) .git'].execute().text.trim()
 
 task buildImage(type: Exec) {
     group       'Build'
     description 'Builds an OCI image from a Dockerfile.'
     dependsOn   tasks.bootJar
-    commandLine ("sh", "-c", "docker build --build-arg spring_boot_jar=$bootJarPath -t $ociImageName:$gitShortCommit ."
+    commandLine ("sh", "-c", "docker build --build-arg jar=$jarPathForOCI -t $ociImageName:$gitShortCommit ."
             + " && docker tag $ociImageName:$gitShortCommit $ociImageName:dev")
 }

gradle.properties

@@ -1,2 +1,2 @@
-version=7.0.2
-iexecCommonVersion=5.9.1
+version=7.1.0
+iexecCommonVersion=6.0.0

iexec-result-proxy-library/build.gradle

@@ -0,0 +1,47 @@
+plugins {
+    id 'java-library'
+    id 'jacoco'
+    id 'maven-publish'
+}
+
+dependencies {
+    implementation "com.iexec.common:iexec-common:$iexecCommonVersion"
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.8.2'
+}
+
+java {
+    withJavadocJar()
+    withSourcesJar()
+}
+
+test {
+    useJUnitPlatform()
+}
+
+jacoco {
+    toolVersion = "0.8.7"
+}
+// sonarqube code coverage requires jacoco XML report
+jacocoTestReport {
+    reports {
+        xml.enabled true
+    }
+}
+tasks.test.finalizedBy tasks.jacocoTestReport
+
+publishing {
+    publications {
+        maven(MavenPublication) {
+            from components.java
+        }
+    }
+    repositories {
+        maven {
+            credentials {
+                username project.hasProperty("nexusUser")? project.nexusUser: ''
+                password project.hasProperty("nexusPassword")? project.nexusPassword: ''
+            }
+            url = project.hasProperty("nexusUrl")? project.nexusUrl: ''
+        }
+    }
+}

iexec-result-proxy-library/src/main/java/com/iexec/resultproxy/api/ResultProxyClient.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2022 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.resultproxy.api;
+
+import com.iexec.common.chain.eip712.entity.EIP712Challenge;
+import com.iexec.common.result.ResultModel;
+import feign.Headers;
+import feign.Param;
+import feign.RequestLine;
+import feign.Response;
+
+/**
+ * Interface allowing to instantiate a Feign client targeting Result Proxy REST endpoints.
+ * <p>
+ * To create the client, see the related builder.
+ * @see ResultProxyClientBuilder
+ */
+public interface ResultProxyClient {
+
+    @RequestLine("GET /results/challenge?chainId={chainId}")
+    EIP712Challenge getChallenge(@Param("chainId") int chainId);
+
+    @RequestLine("POST /results/login?chainId={chainId}")
+    String login(@Param("chainId") int chainId, String token);
+
+    @RequestLine("POST /")
+    @Headers("Authorization: {authorization}")
+    String addResult(
+            @Param("authorization") String authorization,
+            ResultModel model
+    );
+
+    @RequestLine("HEAD /results/{chainTaskId}")
+    @Headers("Authorization: {authorization}")
+    String isResultUploaded(
+            @Param("authorization") String authorization,
+            @Param("chainTaskId") String chainTaskId
+    );
+
+    @RequestLine("GET /results/{chainTaskId}?chainId={chainId}")
+    @Headers({"Accept: application/zip", "Authorization: {authorization}"})
+    Response getResult(
+            @Param("chainTaskId") String chainTaskId,
+            @Param("authorization") String token,
+            @Param("chainId") int chainId
+    );
+
+    @RequestLine("GET /results/{chainTaskId}/ipfshash")
+    String getIpfsHashForTask(@Param("chainTaskId") String chainTaskId);
+
+}

iexec-result-proxy-library/src/main/java/com/iexec/resultproxy/api/ResultProxyClientBuilder.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2022 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.resultproxy.api;
+
+import com.iexec.common.utils.FeignBuilder;
+import feign.Logger;
+
+/**
+ * Creates Feign client instances to query REST endpoints described in {@link ResultProxyClient}.
+ * @see FeignBuilder
+ */
+public class ResultProxyClientBuilder {
+
+    private ResultProxyClientBuilder() {}
+
+    public static ResultProxyClient getInstance(Logger.Level logLevel, String url) {
+        return FeignBuilder.createBuilder(logLevel)
+                .target(ResultProxyClient.class, url);
+    }
+
+}

iexec-result-proxy-library/src/test/java/com/iexec/resultproxy/api/ResultProxyClientTest.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2022 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.resultproxy.api;
+
+import feign.Logger;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+public class ResultProxyClientTest {
+
+    @Test
+    void instantiationTest() {
+        Assertions.assertNotNull(ResultProxyClientBuilder.getInstance(Logger.Level.FULL, "localhost"));
+    }
+
+}

settings.gradle

@@ -1 +1,2 @@
 rootProject.name = 'iexec-result-proxy'
+include 'iexec-result-proxy-library'