fix: call retrieveTeeServicesProperties instead of getTeeServicesProperties in TeeService

Author: jbern0rd

src/main/java/com/iexec/worker/tee/TeeService.java

@@ -17,6 +17,7 @@
 package com.iexec.worker.tee;
 
 import com.github.dockerjava.api.model.Device;
+import com.iexec.common.replicate.ReplicateStatusCause;
 import com.iexec.commons.poco.chain.WorkerpoolAuthorization;
 import com.iexec.commons.poco.task.TaskDescription;
 import com.iexec.sms.api.SmsClientCreationException;
@@ -32,8 +33,6 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
-import static com.iexec.common.replicate.ReplicateStatusCause.*;
-
 @Slf4j
 public abstract class TeeService {
     private final SmsService smsService;
@@ -49,7 +48,7 @@ protected TeeService(final SmsService smsService,
 
     public List<WorkflowError> areTeePrerequisitesMetForTask(final String chainTaskId) {
         if (!isTeeEnabled()) {
-            return List.of(new WorkflowError(TEE_NOT_SUPPORTED));
+            return List.of(new WorkflowError(ReplicateStatusCause.TEE_NOT_SUPPORTED));
         }
 
         try {
@@ -58,21 +57,12 @@ public List<WorkflowError> areTeePrerequisitesMetForTask(final String chainTaskI
             smsService.getSmsClient(chainTaskId);
         } catch (SmsClientCreationException e) {
             log.error("Couldn't get SmsClient [chainTaskId: {}]", chainTaskId, e);
-            return List.of(new WorkflowError(UNKNOWN_SMS));
-        }
-        try {
-            // Try to load the `TeeServicesProperties` relative to the task.
-            // If it can't be loaded, then we won't be able to run the task.
-            teeServicesPropertiesService.getTeeServicesProperties(chainTaskId);
-        } catch (NullPointerException e) {
-            log.error("TEE enclave configuration is null [chainTaskId: {}]", chainTaskId, e);
-            return List.of(new WorkflowError(PRE_COMPUTE_MISSING_ENCLAVE_CONFIGURATION));
-        } catch (RuntimeException e) {
-            log.error("Couldn't get TeeServicesProperties [chainTaskId: {}]", chainTaskId, e);
-            return List.of(new WorkflowError(GET_TEE_SERVICES_CONFIGURATION_FAILED));
+            return List.of(new WorkflowError(ReplicateStatusCause.UNKNOWN_SMS));
         }
 
-        return List.of();
+        // Try to load the `TeeServicesProperties` relative to the task.
+        // If it can't be loaded, then we won't be able to run the task.
+        return teeServicesPropertiesService.retrieveTeeServicesProperties(chainTaskId);
     }
 
     public void createTeeSession(final WorkerpoolAuthorization workerpoolAuthorization) throws TeeSessionGenerationException {

src/main/java/com/iexec/worker/tee/TeeServicesPropertiesService.java

@@ -70,7 +70,7 @@ public TeeServicesProperties getTeeServicesProperties(final String chainTaskId)
     public List<WorkflowError> retrieveTeeServicesProperties(final String chainTaskId) {
         final TaskDescription taskDescription = iexecHubService.getTaskDescription(chainTaskId);
 
-        // FIXME better errors
+        // TODO errors could be renamed for APP enclave checks
         final TeeEnclaveConfiguration teeEnclaveConfiguration = taskDescription.getAppEnclaveConfiguration();
         if (teeEnclaveConfiguration == null) {
             log.error("No enclave configuration found for task [chainTaskId:{}]", chainTaskId);
@@ -103,11 +103,11 @@ public List<WorkflowError> retrieveTeeServicesProperties(final String chainTaskI
         }
 
         final TeeServicesProperties properties = smsClient.getTeeServicesPropertiesVersion(teeFramework, teeEnclaveConfiguration.getVersion());
-        log.info("Received TEE services properties [properties:{}]", properties);
         if (properties == null) {
             return List.of(new WorkflowError(ReplicateStatusCause.GET_TEE_SERVICES_CONFIGURATION_FAILED,
                     String.format("Missing TEE services properties [chainTaskId:%s]", chainTaskId)));
         }
+        log.info("TEE services properties received [chainTaskId:{}]", chainTaskId);
 
         final String preComputeImage = properties.getPreComputeProperties().getImage();
         final String postComputeImage = properties.getPostComputeProperties().getImage();
@@ -118,6 +118,8 @@ public List<WorkflowError> retrieveTeeServicesProperties(final String chainTaskI
 
         if (errors.isEmpty()) {
             propertiesForTask.put(chainTaskId, properties);
+            log.info("TEE services properties storage in cache [chainTaskId:{}, contains-key:{}]",
+                    chainTaskId, propertiesForTask.containsKey(chainTaskId));
         }
         return List.copyOf(errors);
     }
@@ -140,8 +142,9 @@ private List<WorkflowError> checkImageIsPresentOrDownload(final String image, fi
      */
     @Override
     public boolean purgeTask(final String chainTaskId) {
-        log.debug("purgeTask [chainTaskId:{}]", chainTaskId);
         propertiesForTask.remove(chainTaskId);
+        log.info("TEE services properties removal from cache [chainTaskId:{}, contains-key:{}]",
+                chainTaskId, propertiesForTask.containsKey(chainTaskId));
         return !propertiesForTask.containsKey(chainTaskId);
     }
 

src/test/java/com/iexec/worker/tee/scone/TeeSconeServiceTests.java

@@ -16,6 +16,7 @@
 
 package com.iexec.worker.tee.scone;
 
+import com.iexec.common.replicate.ReplicateStatusCause;
 import com.iexec.commons.poco.task.TaskDescription;
 import com.iexec.commons.poco.tee.TeeEnclaveConfiguration;
 import com.iexec.sms.api.SmsClient;
@@ -25,11 +26,12 @@
 import com.iexec.sms.api.config.TeeAppProperties;
 import com.iexec.worker.sgx.SgxService;
 import com.iexec.worker.sms.SmsService;
-import com.iexec.worker.tee.TeeServicesPropertiesCreationException;
 import com.iexec.worker.tee.TeeServicesPropertiesService;
 import com.iexec.worker.workflow.WorkflowError;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
@@ -99,7 +101,7 @@ void shouldTeeNotBeEnabled() {
     void shouldTeePrerequisiteMetForTask() {
         when(sgxService.isSgxEnabled()).thenReturn(true);
         when(smsService.getSmsClient(CHAIN_TASK_ID)).thenReturn(smsClient);
-        when(teeServicesPropertiesService.getTeeServicesProperties(CHAIN_TASK_ID)).thenReturn(null);
+        when(teeServicesPropertiesService.retrieveTeeServicesProperties(CHAIN_TASK_ID)).thenReturn(List.of());
         when(lasServicesManager.startLasService(CHAIN_TASK_ID)).thenReturn(true);
 
         final List<WorkflowError> teePrerequisitesIssue =
@@ -109,7 +111,7 @@ void shouldTeePrerequisiteMetForTask() {
 
         verify(sgxService, times(2)).isSgxEnabled();
         verify(smsService).getSmsClient(CHAIN_TASK_ID);
-        verify(teeServicesPropertiesService).getTeeServicesProperties(CHAIN_TASK_ID);
+        verify(teeServicesPropertiesService).retrieveTeeServicesProperties(CHAIN_TASK_ID);
         verify(lasServicesManager).startLasService(CHAIN_TASK_ID);
     }
 
@@ -143,47 +145,31 @@ void shouldTeePrerequisiteNotMetForTaskSinceSmsClientCantBeLoaded() {
         verifyNoInteractions(teeServicesPropertiesService, lasServicesManager);
     }
 
-    @Test
-    void shouldTeePrerequisiteNotMetForTaskSinceTeeWorkflowConfigurationCantBeLoaded() {
+    @ParameterizedTest
+    @EnumSource(value = ReplicateStatusCause.class, names = {"PRE_COMPUTE_MISSING_ENCLAVE_CONFIGURATION", "GET_TEE_SERVICES_CONFIGURATION_FAILED"})
+    void shouldTeePrerequisiteNotMetForTaskSinceTeeWorkflowConfigurationCantBeLoaded(final ReplicateStatusCause cause) {
         when(sgxService.isSgxEnabled()).thenReturn(true);
         when(smsService.getSmsClient(CHAIN_TASK_ID)).thenReturn(smsClient);
-        when(teeServicesPropertiesService.getTeeServicesProperties(CHAIN_TASK_ID))
-                .thenThrow(TeeServicesPropertiesCreationException.class);
+        when(teeServicesPropertiesService.retrieveTeeServicesProperties(CHAIN_TASK_ID))
+                .thenReturn(List.of(new WorkflowError(cause)));
 
         final List<WorkflowError> teePrerequisitesIssue =
                 teeSconeService.areTeePrerequisitesMetForTask(CHAIN_TASK_ID);
 
         assertThat(teePrerequisitesIssue)
-                .containsExactly(new WorkflowError(GET_TEE_SERVICES_CONFIGURATION_FAILED));
+                .containsExactly(new WorkflowError(cause));
 
         verify(sgxService, times(2)).isSgxEnabled();
         verify(smsService).getSmsClient(CHAIN_TASK_ID);
-        verify(teeServicesPropertiesService).getTeeServicesProperties(CHAIN_TASK_ID);
-        verifyNoInteractions(lasServicesManager);
-    }
-
-    @Test
-    void shouldTeePrerequisitesNotBeMetSinceTeeEnclaveConfigurationIsNull() {
-        when(sgxService.isSgxEnabled()).thenReturn(true);
-        when(smsService.getSmsClient(CHAIN_TASK_ID)).thenReturn(smsClient);
-        when(teeServicesPropertiesService.getTeeServicesProperties(CHAIN_TASK_ID))
-                .thenThrow(NullPointerException.class);
-
-        final List<WorkflowError> teePrerequisitesIssue =
-                teeSconeService.areTeePrerequisitesMetForTask(CHAIN_TASK_ID);
-        assertThat(teePrerequisitesIssue)
-                .containsExactly(new WorkflowError(PRE_COMPUTE_MISSING_ENCLAVE_CONFIGURATION));
-        verify(sgxService, times(2)).isSgxEnabled();
-        verify(smsService).getSmsClient(CHAIN_TASK_ID);
-        verify(teeServicesPropertiesService).getTeeServicesProperties(CHAIN_TASK_ID);
+        verify(teeServicesPropertiesService).retrieveTeeServicesProperties(CHAIN_TASK_ID);
         verifyNoInteractions(lasServicesManager);
     }
 
     @Test
     void shouldTeePrerequisiteNotMetForTaskSinceCantPrepareTee() {
         when(sgxService.isSgxEnabled()).thenReturn(true);
         when(smsService.getSmsClient(CHAIN_TASK_ID)).thenReturn(smsClient);
-        when(teeServicesPropertiesService.getTeeServicesProperties(CHAIN_TASK_ID)).thenReturn(null);
+        when(teeServicesPropertiesService.retrieveTeeServicesProperties(CHAIN_TASK_ID)).thenReturn(List.of());
         when(lasServicesManager.startLasService(CHAIN_TASK_ID)).thenReturn(false);
 
         final List<WorkflowError> teePrerequisitesIssue =
@@ -194,7 +180,7 @@ void shouldTeePrerequisiteNotMetForTaskSinceCantPrepareTee() {
 
         verify(sgxService, times(2)).isSgxEnabled();
         verify(smsService).getSmsClient(CHAIN_TASK_ID);
-        verify(teeServicesPropertiesService).getTeeServicesProperties(CHAIN_TASK_ID);
+        verify(teeServicesPropertiesService).retrieveTeeServicesProperties(CHAIN_TASK_ID);
         verify(lasServicesManager).startLasService(CHAIN_TASK_ID);
     }
     // endregion