Skip to content

feat: add DEAL_ID and TASK_INDEX to TeeSessionEnvironmentVariable #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbern0rd merged 1 commit into from
Sep 25, 2025
Merged

feat: add DEAL_ID and TASK_INDEX to TeeSessionEnvironmentVariable #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions src/main/java/com/iexec/common/utils/IexecEnvUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,11 @@ public class IexecEnvUtils {
* @see #getComputeStageEnvMap(TaskDescription)
*/
public static Map<String, String> getAllIexecEnv(final TaskDescription taskDescription) {
final Map<String, String> envMap = new HashMap<>();
envMap.putAll(getComputeStageEnvMap(taskDescription));
envMap.put(IEXEC_DATASET_URL.name(), taskDescription.getDatasetUri());
envMap.put(IEXEC_DATASET_CHECKSUM.name(), taskDescription.getDatasetChecksum());
final Map<String, String> envMap = new HashMap<>(getComputeStageEnvMap(taskDescription));
if (taskDescription.containsDataset()) {
envMap.put(IEXEC_DATASET_URL.name(), taskDescription.getDatasetUri());
envMap.put(IEXEC_DATASET_CHECKSUM.name(), taskDescription.getDatasetChecksum());
}
if (!taskDescription.containsInputFiles()) {
return envMap;
}
Expand All @@ -65,7 +66,7 @@ public static Map<String, String> getAllIexecEnv(final TaskDescription taskDescr
envMap.put(IEXEC_INPUT_FILE_URL_PREFIX + index, inputFileUrl);
index++;
}
return envMap;
return Map.copyOf(envMap);
}

/**
Expand All @@ -79,6 +80,8 @@ public static Map<String, String> getAllIexecEnv(final TaskDescription taskDescr
*/
public static Map<String, String> getComputeStageEnvMap(final TaskDescription taskDescription) {
final Map<String, String> map = new HashMap<>();
map.put(DEAL_ID.name(), taskDescription.getChainDealId());
map.put(TASK_INDEX.name(), String.valueOf(taskDescription.getBotIndex()));
map.put(IEXEC_TASK_ID.name(), taskDescription.getChainTaskId());
map.put(IEXEC_IN.name(), IexecFileHelper.SLASH_IEXEC_IN);
map.put(IEXEC_OUT.name(), IexecFileHelper.SLASH_IEXEC_OUT);
Expand All @@ -103,7 +106,7 @@ public static Map<String, String> getComputeStageEnvMap(final TaskDescription ta
map.put(IEXEC_INPUT_FILE_NAME_PREFIX + index, FileHashUtils.createFileNameFromUri(inputFileUrl));
index++;
}
return map;
return Map.copyOf(map);
}

/**
Expand All @@ -114,8 +117,8 @@ public static Map<String, String> getComputeStageEnvMap(final TaskDescription ta
* @see #getComputeStageEnvMap(TaskDescription)
*/
public static List<String> getComputeStageEnvList(final TaskDescription taskDescription) {
List<String> list = new ArrayList<>();
final List<String> list = new ArrayList<>();
getComputeStageEnvMap(taskDescription).forEach((key, value) -> list.add(key + "=" + value));
return list;
return List.copyOf(list);
}
}
2 changes: 2 additions & 0 deletions src/main/java/com/iexec/common/worker/tee/TeeSessionEnvironmentVariable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@

public enum TeeSessionEnvironmentVariable {
// common
DEAL_ID,
TASK_INDEX,
IEXEC_TASK_ID,
SIGN_WORKER_ADDRESS,
SIGN_TEE_CHALLENGE_PRIVATE_KEY,
Expand Down
88 changes: 48 additions & 40 deletions src/test/java/com/iexec/common/utils/IexecEnvUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,99 +16,104 @@

package com.iexec.common.utils;

import com.iexec.common.worker.tee.TeeSessionEnvironmentVariable;
import com.iexec.commons.poco.chain.DealParams;
import com.iexec.commons.poco.task.TaskDescription;
import org.junit.jupiter.api.Test;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import static com.iexec.common.utils.IexecEnvUtils.*;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.assertj.core.api.Assertions.assertThat;

class IexecEnvUtilsTest {

private static final String CHAIN_DEAL_ID = "chainDealId";
private static final String CHAIN_TASK_ID = "chainTaskId";
private static final String DATASET_URL = "datasetUrl";
private static final String DATASET_CHECKSUM = "datasetChecksum";
private static final String DATASET_ADDRESS = "datasetAddress";
private static final String INPUT_FILE_1 = "http://host/filename";
private static final String INPUT_FILE_NAME_1 = FileHashUtils.createFileNameFromUri(INPUT_FILE_1);

private final TaskDescription.TaskDescriptionBuilder taskDescriptionBuilder = TaskDescription.builder()
.chainDealId(CHAIN_DEAL_ID)
.chainTaskId(CHAIN_TASK_ID);

// region getAllIexecEnv
@Test
void shouldGetAllIexecEnvWhenNoInputFiles() {
final TaskDescription taskDescription = TaskDescription.builder()
.chainTaskId(CHAIN_TASK_ID)
final TaskDescription taskDescription = taskDescriptionBuilder
.botIndex(0)
.datasetAddress(DATASET_ADDRESS)
.datasetUri(DATASET_URL)
.datasetChecksum(DATASET_CHECKSUM)
.dealParams(DealParams.builder().build())
.build();
final Map<String, String> map = getAllIexecEnv(taskDescription);
assertEquals(DATASET_URL, map.get("IEXEC_DATASET_URL"));
assertEquals(DATASET_CHECKSUM, map.get("IEXEC_DATASET_CHECKSUM"));
checkComputeStageMap(map, taskDescription);
assertEquals("0", map.get("IEXEC_INPUT_FILES_NUMBER"));
assertThat(map)
.containsAllEntriesOf(getExpectedComputeStageMapValues(taskDescription))
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_INPUT_FILES_NUMBER.name(), "0")
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_DATASET_URL.name(), DATASET_URL)
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_DATASET_CHECKSUM.name(), DATASET_CHECKSUM);
}

@Test
void shouldGetAllIexecEnv() {
final DealParams dealParams = DealParams.builder()
.iexecInputFiles(List.of(INPUT_FILE_1))
.build();
final TaskDescription taskDescription = TaskDescription.builder()
.chainTaskId(CHAIN_TASK_ID)
final TaskDescription taskDescription = taskDescriptionBuilder
.datasetAddress(DATASET_ADDRESS)
.datasetUri(DATASET_URL)
.datasetChecksum(DATASET_CHECKSUM)
.dealParams(dealParams)
.build();
final Map<String, String> map = getAllIexecEnv(taskDescription);
assertEquals(DATASET_URL, map.get("IEXEC_DATASET_URL"));
assertEquals(DATASET_CHECKSUM, map.get("IEXEC_DATASET_CHECKSUM"));
assertEquals(INPUT_FILE_1, map.get("IEXEC_INPUT_FILE_URL_1"));
checkComputeStageMap(map, taskDescription);
assertEquals("1", map.get("IEXEC_INPUT_FILES_NUMBER"));
assertEquals(IexecFileHelper.SLASH_IEXEC_IN, map.get("IEXEC_INPUT_FILES_FOLDER"));
assertEquals(INPUT_FILE_NAME_1, map.get("IEXEC_INPUT_FILE_NAME_1"));
assertThat(map)
.containsAllEntriesOf(getExpectedComputeStageMapValues(taskDescription))
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_DATASET_URL.name(), DATASET_URL)
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_DATASET_CHECKSUM.name(), DATASET_CHECKSUM)
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_INPUT_FILES_FOLDER.name(), IexecFileHelper.SLASH_IEXEC_IN)
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_INPUT_FILES_NUMBER.name(), "1")
.containsEntry("IEXEC_INPUT_FILE_URL_1", INPUT_FILE_1)
.containsEntry("IEXEC_INPUT_FILE_NAME_1", INPUT_FILE_NAME_1);
}
// endregion

// region getComputeStageEnvMap
@Test
void shouldGetComputeStageEnvMapWhenNoInputFiles() {
final TaskDescription taskDescription = TaskDescription.builder()
.chainTaskId(CHAIN_TASK_ID)
final TaskDescription taskDescription = taskDescriptionBuilder
.datasetAddress(DATASET_ADDRESS)
.botSize(1)
.botFirstIndex(0)
.dealParams(DealParams.builder().build())
.build();
final Map<String, String> map = getComputeStageEnvMap(taskDescription);
checkComputeStageMap(map, taskDescription);
assertEquals("0", map.get("IEXEC_INPUT_FILES_NUMBER"));
assertThat(map)
.containsAllEntriesOf(getExpectedComputeStageMapValues(taskDescription))
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_INPUT_FILES_NUMBER.name(), "0");
}

@Test
void shouldGetComputeStageEnvMap() {
final DealParams dealParams = DealParams.builder()
.iexecInputFiles(List.of(INPUT_FILE_1))
.build();
final TaskDescription taskDescription = TaskDescription.builder()
.chainTaskId(CHAIN_TASK_ID)
final TaskDescription taskDescription = taskDescriptionBuilder
.datasetAddress(DATASET_ADDRESS)
.botSize(1)
.botFirstIndex(0)
.dealParams(dealParams)
.build();
final Map<String, String> map = getComputeStageEnvMap(taskDescription);
checkComputeStageMap(map, taskDescription);
assertEquals("1", map.get("IEXEC_INPUT_FILES_NUMBER"));
assertEquals(IexecFileHelper.SLASH_IEXEC_IN, map.get("IEXEC_INPUT_FILES_FOLDER"));
assertEquals(INPUT_FILE_NAME_1, map.get("IEXEC_INPUT_FILE_NAME_1"));
assertThat(map)
.containsAllEntriesOf(getExpectedComputeStageMapValues(taskDescription))
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_INPUT_FILES_NUMBER.name(), "1")
.containsEntry(TeeSessionEnvironmentVariable.IEXEC_INPUT_FILES_FOLDER.name(), IexecFileHelper.SLASH_IEXEC_IN)
.containsEntry("IEXEC_INPUT_FILE_NAME_1", INPUT_FILE_NAME_1);
}
// endregion

Expand All @@ -117,14 +122,15 @@ void shouldGetComputeStageEnvList() {
final DealParams dealParams = DealParams.builder()
.iexecInputFiles(List.of(INPUT_FILE_1))
.build();
final TaskDescription taskDescription = TaskDescription.builder()
.chainTaskId(CHAIN_TASK_ID)
final TaskDescription taskDescription = taskDescriptionBuilder
.datasetAddress(DATASET_ADDRESS)
.botSize(1)
.botFirstIndex(0)
.dealParams(dealParams)
.build();
final List<String> expected = Arrays.asList(
final List<String> expected = List.of(
"DEAL_ID=chainDealId",
"TASK_INDEX=0",
"IEXEC_TASK_ID=chainTaskId",
"IEXEC_IN=/iexec_in",
"IEXEC_OUT=/iexec_out",
Expand All @@ -137,16 +143,18 @@ void shouldGetComputeStageEnvList() {
"IEXEC_INPUT_FILES_NUMBER=1",
"IEXEC_INPUT_FILE_NAME_1=" + INPUT_FILE_NAME_1);
final List<String> actual = getComputeStageEnvList(taskDescription);
Collections.sort(expected);
Collections.sort(actual);
assertEquals(expected, actual);
assertThat(actual).containsExactlyInAnyOrderElementsOf(expected);
}

private void checkComputeStageMap(final Map<String, String> map, final TaskDescription taskDescription) {
assertEquals(taskDescription.getChainTaskId(), map.get("IEXEC_TASK_ID"));
assertEquals(IexecFileHelper.SLASH_IEXEC_IN, map.get("IEXEC_IN"));
assertEquals(IexecFileHelper.SLASH_IEXEC_OUT, map.get("IEXEC_OUT"));
assertEquals(taskDescription.getDatasetAddress(), map.get("IEXEC_DATASET_ADDRESS"));
assertEquals(taskDescription.getDatasetAddress(), map.get("IEXEC_DATASET_FILENAME"));
private Map<String, String> getExpectedComputeStageMapValues(final TaskDescription taskDescription) {
return Map.of(
TeeSessionEnvironmentVariable.DEAL_ID.name(), taskDescription.getChainDealId(),
TeeSessionEnvironmentVariable.TASK_INDEX.name(), String.valueOf(taskDescription.getBotIndex()),
TeeSessionEnvironmentVariable.IEXEC_TASK_ID.name(), taskDescription.getChainTaskId(),
TeeSessionEnvironmentVariable.IEXEC_IN.name(), IexecFileHelper.SLASH_IEXEC_IN,
TeeSessionEnvironmentVariable.IEXEC_OUT.name(), IexecFileHelper.SLASH_IEXEC_OUT,
TeeSessionEnvironmentVariable.IEXEC_DATASET_ADDRESS.name(), taskDescription.getDatasetAddress(),
TeeSessionEnvironmentVariable.IEXEC_DATASET_FILENAME.name(), taskDescription.getDatasetAddress()
);
}
}