Use new FileHashUtils API (#622)

Author: jbern0rd

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
 - Add workerpool address in configuration instead of reading from Scheduler `/workers/config` endpoint. (#607)
 - Set `0x0` as default value for Workerpool address and prevents startup if incorrectly configured. (#608)
 - Implement `Purgeable` on `SubscriptionService`. (#620)
+- Use new `FileHashUtils` API. (#622)
 
 ### Bug fixes
 

gradle.properties

@@ -1,5 +1,5 @@
 version=8.5.0
-iexecCommonVersion=8.5.0
+iexecCommonVersion=8.5.0-NEXT-SNAPSHOT
 iexecCommonsContainersVersion=1.2.2
 iexecCommonsPocoVersion=4.1.0-NEXT-SNAPSHOT
 iexecResultVersion=8.5.0

src/main/java/com/iexec/worker/dataset/DataService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 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.
@@ -30,7 +30,6 @@
 
 import javax.annotation.Nonnull;
 import java.io.File;
-import java.nio.file.Paths;
 import java.util.List;
 
 
@@ -47,20 +46,20 @@ public DataService(WorkerConfigurationService workerConfigurationService) {
     /**
      * Download dataset file for the given standard task and save
      * it in {@link IexecFileHelper#SLASH_IEXEC_IN}.
-     * 
+     *
      * @param taskDescription Task description containing dataset related parameters
      * @return downloaded dataset file path
      * @throws WorkflowException if download fails or bad checksum.
      */
     public String downloadStandardDataset(@Nonnull TaskDescription taskDescription)
             throws WorkflowException {
-        String chainTaskId = taskDescription.getChainTaskId();
-        String uri = taskDescription.getDatasetUri();
-        String filename = taskDescription.getDatasetAddress();
-        String parentDirectoryPath = workerConfigurationService.getTaskInputDir(chainTaskId);
+        final String chainTaskId = taskDescription.getChainTaskId();
+        final String uri = taskDescription.getDatasetUri();
+        final String filename = taskDescription.getDatasetAddress();
+        final String parentDirectoryPath = workerConfigurationService.getTaskInputDir(chainTaskId);
         String datasetLocalFilePath = "";
         if (MultiAddressHelper.isMultiAddress(uri)) {
-            for (String ipfsGateway : MultiAddressHelper.IPFS_GATEWAYS) {
+            for (final String ipfsGateway : MultiAddressHelper.IPFS_GATEWAYS) {
                 log.debug("Try to download dataset from {}", ipfsGateway);
                 datasetLocalFilePath =
                         downloadFile(chainTaskId, ipfsGateway + uri, parentDirectoryPath, filename);
@@ -75,17 +74,16 @@ public String downloadStandardDataset(@Nonnull TaskDescription taskDescription)
         if (datasetLocalFilePath.isEmpty()) {
             throw new WorkflowException(ReplicateStatusCause.DATASET_FILE_DOWNLOAD_FAILED);
         }
-        String expectedSha256 = taskDescription.getDatasetChecksum();
+        final String expectedSha256 = taskDescription.getDatasetChecksum();
         if (StringUtils.isEmpty(expectedSha256)) {
-            log.warn("INSECURE! Cannot check empty on-chain dataset checksum " +
-                    "[chainTaskId:{}]", chainTaskId);
+            log.warn("INSECURE! Cannot check empty on-chain dataset checksum [chainTaskId:{}]",
+                    chainTaskId);
             return datasetLocalFilePath;
         }
-        String actualSha256 = FileHashUtils.sha256(new File(datasetLocalFilePath));
+        final String actualSha256 = FileHashUtils.sha256(new File(datasetLocalFilePath));
         if (!expectedSha256.equals(actualSha256)) {
-            log.error("Dataset checksum mismatch [chainTaskId:{}, " +
-                    "expected:{}, actual:{}]", chainTaskId, expectedSha256,
-                    actualSha256);
+            log.error("Dataset checksum mismatch [chainTaskId:{}, expected:{}, actual:{}]",
+                    chainTaskId, expectedSha256, actualSha256);
             throw new WorkflowException(ReplicateStatusCause.DATASET_FILE_BAD_CHECKSUM);
         }
         return datasetLocalFilePath;
@@ -94,18 +92,17 @@ public String downloadStandardDataset(@Nonnull TaskDescription taskDescription)
     /**
      * Download input files for the given standard task and save them
      * in the input folder.
-     * 
+     *
      * @param chainTaskId Task ID used to create input files download folder
-     * @param uriList List of input files to download
+     * @param uriList     List of input files to download
      * @throws WorkflowException if download fails.
      */
-    public void downloadStandardInputFiles(String chainTaskId, @Nonnull List<String> uriList)
+    public void downloadStandardInputFiles(final String chainTaskId, @Nonnull final List<String> uriList)
             throws WorkflowException {
-        for (String uri: uriList) {
-            String filename = !StringUtils.isEmpty(uri)
-                    ? Paths.get(uri).getFileName().toString()
-                    : "";
-            String parenDirectoryPath = workerConfigurationService.getTaskInputDir(chainTaskId);
+        for (final String uri : uriList) {
+            final String filename = FileHashUtils.createFileNameFromUri(uri);
+            final String parenDirectoryPath = workerConfigurationService.getTaskInputDir(chainTaskId);
+            log.debug("Download file [uri:{}, fileName:{}]", uri, filename);
             if (downloadFile(chainTaskId, uri, parenDirectoryPath, filename).isEmpty()) {
                 throw new WorkflowException(ReplicateStatusCause.INPUT_FILES_DOWNLOAD_FAILED);
             }
@@ -115,21 +112,21 @@ public void downloadStandardInputFiles(String chainTaskId, @Nonnull List<String>
     /**
      * Download a file from a URI in the provided parent
      * directory and save it with the provided filename.
-     * 
-     * @param chainTaskId Task ID, for logging purpose
-     * @param uri URI of  single file to download
+     *
+     * @param chainTaskId         Task ID, for logging purpose
+     * @param uri                 URI of  single file to download
      * @param parentDirectoryPath Destination folder on worker host
-     * @param filename Name of downloaded file in destination folder
+     * @param filename            Name of downloaded file in destination folder
      * @return absolute path of the saved file on worker host
      */
-    String downloadFile(String chainTaskId, String uri,
-                        String parentDirectoryPath, String filename) {
+    String downloadFile(final String chainTaskId, final String uri,
+                        final String parentDirectoryPath, final String filename) {
         if (StringUtils.isEmpty(chainTaskId) ||
                 StringUtils.isEmpty(uri) ||
                 StringUtils.isEmpty(parentDirectoryPath) ||
                 StringUtils.isEmpty(filename)) {
             log.error("Failed to download, args shouldn't be empty " +
-                    "[chainTaskId:{}, datasetUri:{}, parentDir:{}, filename:{}]",
+                            "[chainTaskId:{}, datasetUri:{}, parentDir:{}, filename:{}]",
                     chainTaskId, uri, parentDirectoryPath, filename);
             return StringUtils.EMPTY;
         }

src/test/java/com/iexec/worker/dataset/DataServiceTests.java

@@ -17,6 +17,7 @@
 package com.iexec.worker.dataset;
 
 import com.iexec.common.replicate.ReplicateStatusCause;
+import com.iexec.common.utils.FileHashUtils;
 import com.iexec.commons.poco.task.TaskDescription;
 import com.iexec.worker.config.WorkerConfigurationService;
 import com.iexec.worker.utils.WorkflowException;
@@ -85,7 +86,7 @@ void beforeEach() {
     @Test
     void shouldDownloadStandardTaskDataset() throws Exception {
         final TaskDescription taskDescription = getTaskDescriptionBuilder().build();
-        String filepath = dataService.downloadStandardDataset(taskDescription);
+        final String filepath = dataService.downloadStandardDataset(taskDescription);
         assertThat(filepath).isEqualTo(iexecIn + "/" + DATASET_ADDRESS);
     }
 
@@ -178,7 +179,7 @@ void shouldNotDownloadDatasetSinceEmptyUri() {
         final TaskDescription taskDescription = getTaskDescriptionBuilder()
                 .datasetUri("")
                 .build();
-        WorkflowException e = assertThrows(
+        final WorkflowException e = assertThrows(
                 WorkflowException.class,
                 () -> dataService.downloadStandardDataset(taskDescription));
         assertThat(e.getReplicateStatusCause())
@@ -190,7 +191,7 @@ void shouldNotDownloadDatasetSinceEmptyDatasetAddress() {
         final TaskDescription taskDescription = getTaskDescriptionBuilder()
                 .datasetAddress("")
                 .build();
-        WorkflowException e = assertThrows(
+        final WorkflowException e = assertThrows(
                 WorkflowException.class,
                 () -> dataService.downloadStandardDataset(taskDescription));
         assertThat(e.getReplicateStatusCause())
@@ -201,7 +202,7 @@ void shouldNotDownloadDatasetSinceEmptyDatasetAddress() {
     void shouldNotDownloadDatasetSinceEmptyParentDirectory() {
         final TaskDescription taskDescription = getTaskDescriptionBuilder().build();
         when(workerConfigurationService.getTaskInputDir(CHAIN_TASK_ID)).thenReturn("");
-        WorkflowException e = assertThrows(
+        final WorkflowException e = assertThrows(
                 WorkflowException.class,
                 () -> dataService.downloadStandardDataset(taskDescription));
         assertThat(e.getReplicateStatusCause())
@@ -213,7 +214,7 @@ void shouldNotDownloadDatasetSinceBadChecksum() {
         final TaskDescription taskDescription = getTaskDescriptionBuilder()
                 .datasetChecksum("badChecksum")
                 .build();
-        WorkflowException e = assertThrows(
+        final WorkflowException e = assertThrows(
                 WorkflowException.class,
                 () -> dataService.downloadStandardDataset(taskDescription));
         assertThat(e.getReplicateStatusCause())
@@ -231,9 +232,9 @@ void shouldDownloadDatasetSinceEmptyOnchainChecksum() throws Exception {
 
     @Test
     void shouldDownloadInputFiles() throws Exception {
-        List<String> uris = List.of(HTTP_URI);
+        final List<String> uris = List.of(HTTP_URI);
         dataService.downloadStandardInputFiles(CHAIN_TASK_ID, uris);
-        File inputFile = new File(iexecIn, "iExec-RLC-RLC-icon.png");
+        final File inputFile = new File(iexecIn, FileHashUtils.createFileNameFromUri(HTTP_URI));
         assertThat(inputFile).exists();
     }
 }