Added tests for WorkflowSystemMetadataRepository

provider/workflow-azure/src/test/java/org/opengroup/osdu/workflow/provider/azure/repository/WorkflowSystemMetadataRepositoryTest.java

+package org.opengroup.osdu.workflow.provider.azure.repository;
+
+import com.azure.cosmos.models.CosmosQueryRequestOptions;
+import com.azure.cosmos.models.SqlQuerySpec;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.opengroup.osdu.azure.cosmosdb.CosmosStore;
+import org.opengroup.osdu.core.common.logging.JaxRsDpsLog;
+import org.opengroup.osdu.workflow.exception.WorkflowNotFoundException;
+import org.opengroup.osdu.workflow.model.WorkflowMetadata;
+import org.opengroup.osdu.workflow.provider.azure.config.AzureWorkflowEngineConfig;
+import org.opengroup.osdu.workflow.provider.azure.config.CosmosConfig;
+import org.opengroup.osdu.workflow.provider.azure.model.WorkflowMetadataDoc;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Optional;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.equalTo;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.any;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+/**
+ * Tests for {@link WorkflowMetadataRepository}
+ */
+@ExtendWith(MockitoExtension.class)
+public class WorkflowSystemMetadataRepositoryTest {
+  private static final String DATABASE_NAME = "someDbName";
+  private static final String WORKFLOW_METADATA_COLLECTION = "someCollection";
+  private static final String WORKFLOW_NAME = "HelloWorld";
+  private static final String INPUT_WORKFLOW_METADATA_WITH_DAG_CONTENT = "{\n" +
+      "    \"workflowId\": \"foo\",\n" +
+      "    \"workflowName\": \"HelloWorld\",\n" +
+      "    \"description\": \"This is a test workflow\",\n" +
+      "    \"registrationInstructions\": {\n" +
+      "    \"concurrentWorkflowRun\": 5,\n" +
+      "    \"concurrentTaskRun\": 5,\n" +
+      "    \"active\": true,\n" +
+      "    \"dagContent\": \"sample-dag-content\"\n" +
+      "    },\n" +
+      "    \"creationTimestamp\": 1600144876028,\n" +
+      "    \"createdBy\": \"user@email.com\",\n" +
+      "    \"version\": 1\n" +
+      "}";
+
+  private static final String INPUT_WORKFLOW_METADATA_WITHOUT_DAG_CONTENT = "{\n" +
+      "    \"workflowId\": \"foo\",\n" +
+      "    \"workflowName\": \"HelloWorld\",\n" +
+      "    \"description\": \"This is a test workflow\",\n" +
+      "    \"registrationInstructions\": {\n" +
+      "    \"concurrentWorkflowRun\": 5,\n" +
+      "    \"concurrentTaskRun\": 5,\n" +
+      "    \"active\": true\n" +
+      "    },\n" +
+      "    \"creationTimestamp\": 1600144876028,\n" +
+      "    \"createdBy\": \"user@email.com\",\n" +
+      "    \"version\": 1\n" +
+      "}";
+
+  private static final String INPUT_WORKFLOW_METADATA_WITH_EMPTY_DAG_CONTENT = "{\n" +
+      "    \"workflowId\": \"foo\",\n" +
+      "    \"workflowName\": \"HelloWorld\",\n" +
+      "    \"description\": \"This is a test workflow\",\n" +
+      "    \"registrationInstructions\": {\n" +
+      "    \"concurrentWorkflowRun\": 5,\n" +
+      "    \"concurrentTaskRun\": 5,\n" +
+      "    \"active\": true,\n" +
+      "    \"dagContent\": \"\"\n" +
+      "    },\n" +
+      "    \"creationTimestamp\": 1600144876028,\n" +
+      "    \"createdBy\": \"user@email.com\",\n" +
+      "    \"version\": 1\n" +
+      "}";
+
+  private static final String OUTPUT_WORKFLOW_METADATA_WITH_DAG_CONTENT = "{\n" +
+      "    \"workflowId\": \"HelloWorld\",\n" +
+      "    \"workflowName\": \"HelloWorld\",\n" +
+      "    \"description\": \"This is a test workflow\",\n" +
+      "    \"registrationInstructions\": {\n" +
+      "    \"concurrentWorkflowRun\": 5,\n" +
+      "    \"concurrentTaskRun\": 5,\n" +
+      "    \"active\": true\n" +
+      "    },\n" +
+      "    \"isDeployedThroughWorkflowService\": true,\n" +
+      "    \"creationTimestamp\": 1600144876028,\n" +
+      "    \"createdBy\": \"user@email.com\",\n" +
+      "    \"version\": 1\n" +
+      "}";
+
+  private static final String OUTPUT_GET_WORKFLOW_METADATA_WITH_DAG_CONTENT = "{\n" +
+      "    \"workflowId\": \"HelloWorld\",\n" +
+      "    \"workflowName\": \"HelloWorld\",\n" +
+      "    \"description\": \"This is a test workflow\",\n" +
+      "    \"registrationInstructions\": {\n" +
+      "    \"concurrentWorkflowRun\": 5,\n" +
+      "    \"concurrentTaskRun\": 5,\n" +
+      "    \"active\": true\n" +
+      "    },\n" +
+      "    \"isDeployedThroughWorkflowService\": true,\n" +
+      "    \"creationTimestamp\": 1600144876028,\n" +
+      "    \"createdBy\": \"user@email.com\",\n" +
+      "    \"version\": 1\n" +
+      "}";
+  private static final String OUTPUT_WORKFLOW_METADATA_WITHOUT_DAG_CONTENT = "{\n" +
+      "    \"workflowId\": \"HelloWorld\",\n" +
+      "    \"workflowName\": \"HelloWorld\",\n" +
+      "    \"description\": \"This is a test workflow\",\n" +
+      "    \"registrationInstructions\": {\n" +
+      "    \"concurrentWorkflowRun\": 5,\n" +
+      "    \"concurrentTaskRun\": 5,\n" +
+      "    \"active\": true\n" +
+      "    },\n" +
+      "    \"isDeployedThroughWorkflowService\": false,\n" +
+      "    \"creationTimestamp\": 1600144876028,\n" +
+      "    \"createdBy\": \"user@email.com\",\n" +
+      "    \"version\": 1\n" +
+      "}";
+  private static final String WORKFLOW_METADATA_DOC_WITH_DAG_CONTENT = "{\n" +
+      "    \"id\": \"HelloWorld\",\n" +
+      "    \"partitionKey\": \"HelloWorld\",\n" +
+      "    \"workflowName\": \"HelloWorld\",\n" +
+      "    \"description\": \"This is a test workflow\",\n" +
+      "    \"registrationInstructions\": {\n" +
+      "    \"concurrentWorkflowRun\": 5,\n" +
+      "    \"concurrentTaskRun\": 5,\n" +
+      "    \"active\": true\n" +
+      "    },\n" +
+      "    \"isRegisteredByWorkflowService\": true,\n" +
+      "    \"creationTimestamp\": 1600144876028,\n" +
+      "    \"createdBy\": \"user@email.com\",\n" +
+      "    \"version\": 1\n" +
+      "}";
+
+  private static final String WORKFLOW_METADATA_DOC_WITHOUT_OR_EMPTY_DAG_CONTENT = "{\n" +
+      "    \"id\": \"HelloWorld\",\n" +
+      "    \"partitionKey\": \"HelloWorld\",\n" +
+      "    \"workflowName\": \"HelloWorld\",\n" +
+      "    \"description\": \"This is a test workflow\",\n" +
+      "    \"registrationInstructions\": {\n" +
+      "    \"concurrentWorkflowRun\": 5,\n" +
+      "    \"concurrentTaskRun\": 5,\n" +
+      "    \"active\": true\n" +
+      "    },\n" +
+      "    \"isRegisteredByWorkflowService\": false,\n" +
+      "    \"creationTimestamp\": 1600144876028,\n" +
+      "    \"createdBy\": \"user@email.com\",\n" +
+      "    \"version\": 1\n" +
+      "}";
+  private static final String PREFIX_VALUE = "Hello";
+
+  private static final String SQL_QUERY_SPEC_QUERY_TEXT_WITH_PREFIX = "SELECT * FROM c " +
+      "where STARTSWITH(c.workflowName, @prefix, true) " +
+      "ORDER BY c._ts DESC";
+  private static final String SQL_QUERY_SPEC_QUERY_TEXT_WITHOUT_PREFIX = "SELECT * FROM c " +
+      "ORDER BY c._ts DESC";
+
+  private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
+
+  @Mock
+  private CosmosConfig cosmosConfig;
+
+  @Mock
+  private AzureWorkflowEngineConfig workflowEngineConfig;
+
+  @Mock
+  private CosmosStore cosmosStore;
+
+  @Mock
+  private JaxRsDpsLog jaxRsDpsLog;
+
+  @InjectMocks
+  private WorkflowSystemMetadataRepository workflowSystemMetadataRepository;
+
+  @Test
+  public void testCreateSystemWorkflowWithDAGContent() throws Exception {
+    when(workflowEngineConfig.getIgnoreDagContent()).thenReturn(false);
+    final WorkflowMetadata inputWorkflowMetadata = OBJECT_MAPPER.readValue(INPUT_WORKFLOW_METADATA_WITH_DAG_CONTENT, WorkflowMetadata.class);
+    final WorkflowMetadata expectedOutputWorkflowMetadata = OBJECT_MAPPER.readValue(OUTPUT_WORKFLOW_METADATA_WITH_DAG_CONTENT, WorkflowMetadata.class);
+    final WorkflowMetadataDoc expectedDocToBeStored =
+        OBJECT_MAPPER.readValue(WORKFLOW_METADATA_DOC_WITH_DAG_CONTENT, WorkflowMetadataDoc.class);
+    testCreateWorkflowWithoutPartitionId(inputWorkflowMetadata, expectedOutputWorkflowMetadata, expectedDocToBeStored);
+  }
+
+  @Test
+  public void testCreateSystemWorkflowWithoutDAGContent() throws Exception {
+    final WorkflowMetadata inputWorkflowMetadata = OBJECT_MAPPER.readValue(INPUT_WORKFLOW_METADATA_WITHOUT_DAG_CONTENT, WorkflowMetadata.class);
+    final WorkflowMetadata expectedOutputWorkflowMetadata = OBJECT_MAPPER.readValue(OUTPUT_WORKFLOW_METADATA_WITHOUT_DAG_CONTENT, WorkflowMetadata.class);
+    final WorkflowMetadataDoc expectedDocToBeStored =
+        OBJECT_MAPPER.readValue(WORKFLOW_METADATA_DOC_WITHOUT_OR_EMPTY_DAG_CONTENT, WorkflowMetadataDoc.class);
+    testCreateWorkflowWithoutPartitionId(inputWorkflowMetadata, expectedOutputWorkflowMetadata, expectedDocToBeStored);
+  }
+
+  @Test
+  public void testCreateSystemWorkflowWithEmptyDAGContent() throws Exception {
+    final WorkflowMetadata inputWorkflowMetadata = OBJECT_MAPPER.readValue(INPUT_WORKFLOW_METADATA_WITH_EMPTY_DAG_CONTENT, WorkflowMetadata.class);
+    final WorkflowMetadata expectedOutputWorkflowMetadata = OBJECT_MAPPER.readValue(OUTPUT_WORKFLOW_METADATA_WITHOUT_DAG_CONTENT, WorkflowMetadata.class);
+    final WorkflowMetadataDoc expectedDocToBeStored =
+        OBJECT_MAPPER.readValue(WORKFLOW_METADATA_DOC_WITHOUT_OR_EMPTY_DAG_CONTENT, WorkflowMetadataDoc.class);
+    testCreateWorkflowWithoutPartitionId(inputWorkflowMetadata, expectedOutputWorkflowMetadata, expectedDocToBeStored);
+  }
+
+  @Test
+  public void testGetSystemWorkflowWithExistingWorkflowId() throws Exception {
+    final WorkflowMetadata workflowMetadata = OBJECT_MAPPER.readValue(OUTPUT_GET_WORKFLOW_METADATA_WITH_DAG_CONTENT, WorkflowMetadata.class);
+    final WorkflowMetadataDoc workflowMetadataDoc =
+        OBJECT_MAPPER.readValue(WORKFLOW_METADATA_DOC_WITH_DAG_CONTENT, WorkflowMetadataDoc.class);
+    when(cosmosConfig.getSystemdatabase()).thenReturn(DATABASE_NAME);
+    when(cosmosConfig.getWorkflowMetadataCollection()).thenReturn(WORKFLOW_METADATA_COLLECTION);
+    when(cosmosStore.findItem(eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        eq(WORKFLOW_NAME), eq(WORKFLOW_NAME), eq(WorkflowMetadataDoc.class)))
+        .thenReturn(Optional.of(workflowMetadataDoc));
+    final WorkflowMetadata response = workflowSystemMetadataRepository.getSystemWorkflow(WORKFLOW_NAME);
+    verify(cosmosStore).findItem(eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        eq(WORKFLOW_NAME), eq(WORKFLOW_NAME), eq(WorkflowMetadataDoc.class));
+    verify(cosmosConfig).getSystemdatabase();
+    verify(cosmosConfig).getWorkflowMetadataCollection();
+    assertThat(response, equalTo(workflowMetadata));
+  }
+
+  @Test
+  public void testGetWorkflowWithNonExistingWorkflowId() throws Exception {
+    when(cosmosConfig.getSystemdatabase()).thenReturn(DATABASE_NAME);
+    when(cosmosConfig.getWorkflowMetadataCollection()).thenReturn(WORKFLOW_METADATA_COLLECTION);
+    when(cosmosStore.findItem(eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        eq(WORKFLOW_NAME), eq(WORKFLOW_NAME), eq(WorkflowMetadataDoc.class)))
+        .thenReturn(Optional.empty());
+    Assertions.assertThrows(WorkflowNotFoundException.class, () -> {
+      workflowSystemMetadataRepository.getSystemWorkflow(WORKFLOW_NAME);
+    });
+    verify(cosmosStore, times(1)).findItem(eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        eq(WORKFLOW_NAME), eq(WORKFLOW_NAME), eq(WorkflowMetadataDoc.class));
+    verify(cosmosConfig).getSystemdatabase();
+    verify(cosmosConfig).getWorkflowMetadataCollection();
+  }
+
+  @Test
+  public void testGetAllSystemWorkflow() throws Exception {
+    when(cosmosConfig.getSystemdatabase()).thenReturn(DATABASE_NAME);
+    when(cosmosConfig.getWorkflowMetadataCollection()).thenReturn(WORKFLOW_METADATA_COLLECTION);
+    final WorkflowMetadataDoc workflowMetadataDoc =
+        OBJECT_MAPPER.readValue(WORKFLOW_METADATA_DOC_WITH_DAG_CONTENT, WorkflowMetadataDoc.class);
+    List<WorkflowMetadataDoc> workflowMetadataDocList = Arrays.asList(workflowMetadataDoc);
+    ArgumentCaptor<SqlQuerySpec> sqlQuerySpecArgumentCaptor =
+        ArgumentCaptor.forClass(SqlQuerySpec.class);
+    when(cosmosStore.queryItems(eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        sqlQuerySpecArgumentCaptor.capture(), any(CosmosQueryRequestOptions.class),
+        eq(WorkflowMetadataDoc.class))).thenReturn(workflowMetadataDocList);
+    List<WorkflowMetadata> responseWorkflowMetadataList =
+        workflowSystemMetadataRepository.getAllSystemWorkflow(PREFIX_VALUE);
+    verify(cosmosStore).queryItems( eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        any(SqlQuerySpec.class), any(CosmosQueryRequestOptions.class), eq(WorkflowMetadataDoc.class));
+    verify(cosmosConfig).getSystemdatabase();
+    verify(cosmosConfig).getWorkflowMetadataCollection();
+    assertThat(responseWorkflowMetadataList.size(), equalTo(1));
+    WorkflowMetadata workflowMetadata =
+        OBJECT_MAPPER.readValue(OUTPUT_WORKFLOW_METADATA_WITH_DAG_CONTENT, WorkflowMetadata.class);
+    assertThat(workflowMetadata, equalTo(responseWorkflowMetadataList.get(0)));
+    assertThat(sqlQuerySpecArgumentCaptor.getValue().getQueryText(), equalTo(SQL_QUERY_SPEC_QUERY_TEXT_WITH_PREFIX));
+  }
+
+  @Test
+  public void testGetAllSystemWorkflowEmptyPrefix() throws Exception {
+    when(cosmosConfig.getSystemdatabase()).thenReturn(DATABASE_NAME);
+    when(cosmosConfig.getWorkflowMetadataCollection()).thenReturn(WORKFLOW_METADATA_COLLECTION);
+    final WorkflowMetadataDoc workflowMetadataDoc =
+        OBJECT_MAPPER.readValue(WORKFLOW_METADATA_DOC_WITH_DAG_CONTENT, WorkflowMetadataDoc.class);
+    List<WorkflowMetadataDoc> workflowMetadataDocList = Arrays.asList(workflowMetadataDoc);
+    ArgumentCaptor<SqlQuerySpec> sqlQuerySpecArgumentCaptor =
+        ArgumentCaptor.forClass(SqlQuerySpec.class);
+    when(cosmosStore.queryItems(eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        sqlQuerySpecArgumentCaptor.capture(), any(CosmosQueryRequestOptions.class),
+        eq(WorkflowMetadataDoc.class))).thenReturn(workflowMetadataDocList);
+    List<WorkflowMetadata> responseWorkflowMetadataList =
+        workflowSystemMetadataRepository.getAllSystemWorkflow("");
+    verify(cosmosStore).queryItems( eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        any(SqlQuerySpec.class), any(CosmosQueryRequestOptions.class), eq(WorkflowMetadataDoc.class));
+    verify(cosmosConfig).getSystemdatabase();
+    verify(cosmosConfig).getWorkflowMetadataCollection();
+    assertThat(responseWorkflowMetadataList.size(), equalTo(1));
+    WorkflowMetadata workflowMetadata =
+        OBJECT_MAPPER.readValue(OUTPUT_WORKFLOW_METADATA_WITH_DAG_CONTENT, WorkflowMetadata.class);
+    assertThat(workflowMetadata, equalTo(responseWorkflowMetadataList.get(0)));
+    assertThat(sqlQuerySpecArgumentCaptor.getValue().getQueryText(), equalTo(SQL_QUERY_SPEC_QUERY_TEXT_WITHOUT_PREFIX));
+  }
+
+  @Test
+  public void testDeleteWorkflowWithEmptyPartitionId() {
+    when(cosmosConfig.getSystemdatabase()).thenReturn(DATABASE_NAME);
+    when(cosmosConfig.getWorkflowMetadataCollection()).thenReturn(WORKFLOW_METADATA_COLLECTION);
+    doNothing().when(cosmosStore).deleteItem(eq(DATABASE_NAME),
+        eq(WORKFLOW_METADATA_COLLECTION), eq(WORKFLOW_NAME), eq(WORKFLOW_NAME));
+    workflowSystemMetadataRepository.deleteSystemWorkflow(WORKFLOW_NAME);
+    verify(cosmosStore).deleteItem(eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION),
+        eq(WORKFLOW_NAME), eq(WORKFLOW_NAME));
+    verify(cosmosConfig).getSystemdatabase();
+    verify(cosmosConfig).getWorkflowMetadataCollection();
+  }
+
+  private void testCreateWorkflowWithoutPartitionId(WorkflowMetadata inputWorkflowMetadata,
+                                                    WorkflowMetadata expectedOutputWorkflowMetadata,
+                                                    WorkflowMetadataDoc expectedDocToBeStored) {
+    when(cosmosConfig.getSystemdatabase()).thenReturn(DATABASE_NAME);
+    when(cosmosConfig.getWorkflowMetadataCollection()).thenReturn(WORKFLOW_METADATA_COLLECTION);
+    doNothing().when(cosmosStore)
+        .createItem( eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION), eq(WORKFLOW_NAME), eq(expectedDocToBeStored));
+    final WorkflowMetadata response = workflowSystemMetadataRepository.createSystemWorkflow(inputWorkflowMetadata);
+    verify(cosmosStore, times(1))
+        .createItem( eq(DATABASE_NAME), eq(WORKFLOW_METADATA_COLLECTION), eq(WORKFLOW_NAME), eq(expectedDocToBeStored));
+    verify(cosmosConfig, times(1)).getSystemdatabase();
+    verify(cosmosConfig, times(1)).getWorkflowMetadataCollection();
+    assertThat(response, equalTo(expectedOutputWorkflowMetadata));
+  }
+}