Merge pull request #92 from iExecBlockchainComputing/release/8.1.0

Release/8.1.0

Author: jbern0rd

CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file.
 
+## [[8.1.0]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.1.0) 2023-06-07
+
+### New Features
+- Enable Prometheus actuator. (#79)
+- Rework `QueueService` with a thread pool based on a `PriorityBlockingQueue`. (#84)
+- Do not use `broker` to match ordes on chain. (#87 #88)
+### Bug Fixes
+- Fix security rule to access Swagger API. (#79)
+### Quality
+- Use `testcontainers` in integration tests. (#89)
+- Remove `com.iexec.blockchain.dataset` package and update `feign` client endpoints. (#91)
+### Dependency Upgrades
+- Upgrade to `feign` 11.10. (#80)
+- Upgrade to `iexec-common` 8.2.0. (#83 #85 #90)
+- Upgrade to `iexec-commons-poco` 3.0.2. (#83 #85 #86 #90)
+
 ## [[8.0.1]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.0.1) 2023-04-06
 
 ### Quality

README.md

@@ -25,14 +25,13 @@ To run properly, the iExec Blockchain Adapter API requires:
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_PASSWORD` | Login password of the server. | String | `whatever` |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_MONGO_HOST` | Mongo server host. Cannot be set with URI. | String | `localhost` |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_MONGO_PORT` | Mongo server port. Cannot be set with URI. | Positive integer | `13012` |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_CHAIN_ID` | Chain ID of the blockchain network to connect. | Positive integer | `65535` |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_NODE_ADDRESS` | URL to connect to the blockchain network. | URL | `http://localhost:8545` |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_BLOCK_TIME` | In seconds, parameter of the targeted blockchain. | Positive integer | `1` |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_HUB_ADDRESS` | Proxy contract address to interact with the iExec on-chain protocol. | Ethereum Address | `0xBF6B2B07e47326B7c8bfCb4A5460bef9f0Fd2002` |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_IS_SIDECHAIN` | Define if iExec on-chain protocol is built on top of token (`false`) or native currency (`true`). | Boolean | `false` |
+| `IEXEC_BLOCKCHAIN_ADAPTER_API_CHAIN_ID` | Chain ID of the blockchain network to connect. | Positive integer | `134` |
+| `IEXEC_BLOCKCHAIN_ADAPTER_API_IS_SIDECHAIN` | Define whether iExec on-chain protocol is built on top of token (`false`) or native currency (`true`). | Boolean | `true` |
+| `IEXEC_BLOCKCHAIN_ADAPTER_API_NODE_ADDRESS` | URL to connect to the blockchain network. | URL | `https://bellecour.iex.ec` |
+| `IEXEC_BLOCKCHAIN_ADAPTER_API_BLOCK_TIME` | Duration between consecutive blocks on the blockchain network, in seconds. | Positive integer | `5` |
+| `IEXEC_BLOCKCHAIN_ADAPTER_API_HUB_ADDRESS` | Proxy contract address to interact with the iExec on-chain protocol. | Ethereum Address | `0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f` |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_GAS_PRICE_MULTIPLIER` | Transactions will be sent with `networkGasPrice * gasPriceMultiplier`. | Float | `1.0` |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_GAS_PRICE_CAP` | In Wei, will be used for transactions if `networkGasPrice * gasPriceMultiplier > gasPriceCap`. | Positive integer | `22000000000` |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_BROKER_URL` | URL of the broker to interact with when matching iExec orders. | URL | `http://localhost:3000` |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_WALLET_PATH` | Path to the wallet of the server. | String | `src/main/resources/wallet.json` |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_WALLET_PASSWORD` | Password to unlock the wallet of the server. | String | `whatever` |
 
@@ -49,3 +48,7 @@ No default strategy has been implemented in the [Dockerfile](docker/Dockerfile)
 ## CI/CD build
 
 `docker image build -f docker/Dockerfile .`
+
+## License
+
+This repository code is released under the [Apache License 2.0](LICENSE).

build.gradle

@@ -9,7 +9,7 @@ plugins {
 }
 
 ext {
-	openFeignVersion = '11.7'
+	openFeignVersion = '11.10'
 }
 
 if (!project.hasProperty('gitBranch')) {
@@ -47,9 +47,8 @@ allprojects {
 }
 
 configurations {
-	integrationTestCompile.extendsFrom testCompile
-	integrationTestRuntime.extendsFrom testRuntime
-	integrationTestImplementation.extendsFrom testImplementation
+	itestRuntime.extendsFrom testRuntime
+	itestImplementation.extendsFrom testImplementation
 }
 
 dependencies {
@@ -63,6 +62,7 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 
 	// iexec
+	implementation "com.iexec.commons:iexec-commons-poco:$iexecCommonsPocoVersion"
 	implementation "com.iexec.common:iexec-common:$iexecCommonVersion"
 
 	// web3j bug required
@@ -72,15 +72,19 @@ dependencies {
 	implementation 'com.squareup.okhttp3:okhttp:4.9.0' // Web3j issue: https://github.com/web3j/web3j/issues/1180
 
 	// feign
-	implementation "io.github.openfeign:feign-core:$openFeignVersion"
 	implementation "io.github.openfeign:feign-jackson:$openFeignVersion"
 	implementation "io.github.openfeign:feign-slf4j:$openFeignVersion"
 
+	// observability
+	runtimeOnly 'io.micrometer:micrometer-registry-prometheus'
+
 	// integration tests
 	implementation project(':iexec-blockchain-adapter-api-library')
 
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
-	testImplementation 'org.awaitility:awaitility:4.0.1'
+	testImplementation 'org.awaitility:awaitility'
+
+	itestImplementation 'org.testcontainers:junit-jupiter:1.18.1'
 }
 
 springBoot {
@@ -95,32 +99,24 @@ tasks.named("bootJar") {
 }
 
 sourceSets {
-	integrationTest {
+	itest {
 		java {
 			compileClasspath += main.output + test.output
 			runtimeClasspath += main.output + test.output
-			srcDir 'src/itest/java'
 		}
-		resources.srcDir 'src/itest/resources'
 	}
 }
 
-task itestSetup(type: Exec) {
-	commandLine 'docker-compose', 'up', '-d'
-}
-
-task itestTeardown(type: Exec) {
-	commandLine 'docker-compose', 'down'
-}
-
-task itest(type: Test) {
+tasks.register("itest", Test) {
+	doFirst {
+		exec {
+			commandLine 'docker', 'compose', 'pull', '-q'
+		}
+	}
 	group 'Verification'
 	description 'Runs the integration tests.'
-	dependsOn   itestSetup
-	finalizedBy itestTeardown
-	setTestClassesDirs(sourceSets.integrationTest.output)
-	classpath = sourceSets.integrationTest.runtimeClasspath
-	useJUnitPlatform()
+	setTestClassesDirs(sourceSets.itest.output)
+	classpath = sourceSets.itest.runtimeClasspath
 }
 
 jar {
@@ -148,7 +144,8 @@ publishing {
 	}
 }
 
-test {
+tasks.withType(Test).configureEach {
+	finalizedBy jacocoTestReport
 	useJUnitPlatform()
 }
 
@@ -161,7 +158,6 @@ jacocoTestReport {
         xml.required = true
     }
 }
-tasks.test.finalizedBy    tasks.jacocoTestReport
 tasks.sonarqube.dependsOn tasks.jacocoTestReport
 
 ext.jarPathForOCI  = relativePath(tasks.bootJar.outputs.files.singleFile)

docker-compose.yml

@@ -1,41 +1,11 @@
-version: "3.5"
-
-networks:
-  iexec-blockchain-adapter-api-net:
-    name: iexec-blockchain-adapter-api-net
-
 services:
 
   ibaa-chain:
     image: docker-regis.iex.ec/poco-chain:native-v5.4.2-5s
-    container_name: ibaa-chain
-    ports:
-      - 28545:8545
-    networks:
-      - iexec-blockchain-adapter-api-net
-
-  ibaa-broker:
-    image: docker-regis.iex.ec/iexec-autonomous-brokering-engine:dev #warn, using nexus repo + dev tag, can it be public?
-    container_name: ibaa-broker
-    environment:
-      - CHAIN=http://ibaa-chain:8545
-      - PROXY=0xC129e7917b7c7DeDfAa5Fff1FB18d5D7050fE8ca
-      - MNEMONIC=${BROKER_PRIVATE_KEY} #must use an other wallet for the broker, like wallet-abc
-      - PORT=3000
-    ports:
-      - 23000:3000
-    depends_on:
-      - ibaa-chain
-    networks:
-      - iexec-blockchain-adapter-api-net
-    restart: unless-stopped
+    expose:
+      - "8545"
 
   ibaa-blockchain-adapter-mongo:
     image: library/mongo:4.4
-    container_name: ibaa-blockchain-adapter-mongo
     entrypoint: "/bin/bash"
     command: -c "mongod --bind_ip_all --port 13012"
-    ports:
-      - 23012:13012
-    networks:
-      - iexec-blockchain-adapter-api-net

gradle.properties

@@ -1,5 +1,6 @@
-version=8.0.1
-iexecCommonVersion=7.0.0
+version=8.1.0
+iexecCommonVersion=8.2.0
+iexecCommonsPocoVersion=3.0.2
 
 nexusUser
 nexusPassword

iexec-blockchain-adapter-api-library/build.gradle

@@ -6,6 +6,7 @@ plugins {
 }
 
 dependencies {
+    implementation "com.iexec.commons:iexec-commons-poco:$iexecCommonsPocoVersion"
     implementation "com.iexec.common:iexec-common:$iexecCommonVersion"
     testImplementation 'org.junit.jupiter:junit-jupiter:5.8.2'
 }

iexec-blockchain-adapter-api-library/src/main/java/com/iexec/blockchain/api/BlockchainAdapterApiClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IEXEC BLOCKCHAIN TECH
+ * Copyright 2022-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,15 +16,13 @@
 
 package com.iexec.blockchain.api;
 
-import com.iexec.blockchain.tool.Status;
-import com.iexec.common.chain.ChainDataset;
-import com.iexec.common.chain.ChainTask;
 import com.iexec.common.chain.adapter.CommandStatus;
 import com.iexec.common.chain.adapter.args.TaskContributeArgs;
 import com.iexec.common.chain.adapter.args.TaskFinalizeArgs;
 import com.iexec.common.chain.adapter.args.TaskRevealArgs;
 import com.iexec.common.config.PublicChainConfig;
 import com.iexec.common.sdk.broker.BrokerOrder;
+import com.iexec.commons.poco.chain.ChainTask;
 import feign.Param;
 import feign.RequestLine;
 
@@ -44,20 +42,6 @@ public interface BlockchainAdapterApiClient {
     @RequestLine("POST /broker/broker/orders/match")
     String matchOrders(BrokerOrder brokerOrder);
 
-    @RequestLine("POST /datasets/requests?name={name}&multiAddress={multiAddress}&checksum={checksum}")
-    String createDataset(@Param("name") String name,
-                         @Param("multiAddress") String multiAddress,
-                         @Param("checksum") String checksum);
-
-    @RequestLine("GET /datasets/requests/{requestId}")
-    String getAddressForCreateDatasetRequest(@Param("requestId") String requestId);
-
-    @RequestLine("GET /datasets/requests/{requestId}/status")
-    Status getStatusForCreateDatasetRequest(@Param("requestId") String requestId);
-
-    @RequestLine("GET /datasets?address={address}")
-    ChainDataset getDatasetByAddress(@Param("address") String address);
-
     @RequestLine("GET /metrics")
     String getMetrics();