diff --git a/apis/openapi-spec/pipeline-service.yaml b/apis/openapi-spec/pipeline-service.yaml index 6d945b88..3de5d056 100644 --- a/apis/openapi-spec/pipeline-service.yaml +++ b/apis/openapi-spec/pipeline-service.yaml @@ -156,12 +156,15 @@ paths: $ref: "#/components/schemas/PipelineExecuteRequest" required: true responses: - "203": - description: Non-Authoritative Information + "202": + description: Accepted content: application/json: schema: - $ref: "#/components/schemas/PipelineBuild" + type: object + additionalProperties: + type: string + format: uuid security: - bearerAuth: [] /api/v1/stage/build/logs/{stageBuildId}: diff --git a/docker-compose.yml b/docker-compose.yml index fdc4bd1a..0dd98ccb 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -67,6 +67,19 @@ services: - "8016:8016" networks: - app + rabbitmq: + image: rabbitmq:3-management + container_name: rabbitmq + ports: + - "5672:5672" + - "15672:15672" + networks: + - app + healthcheck: + test: ["CMD", "rabbitmq-diagnostics", "ping"] + interval: 10s + timeout: 5s + retries: 5 pipeline-app: image: pipeline-app container_name: pipeline-app @@ -79,6 +92,7 @@ services: AUTH_PORT: 8080 OTEL_SERVICE_NAME: pipeline-app FEATURE_PROVIDER_URI: http://flagd:8016 + RABBITMQ_URL: amqp://guest:guest@rabbitmq:5672 ports: - "8080:8080" volumes: @@ -92,4 +106,6 @@ services: auth-service: condition: service_healthy flagd: - condition: service_started \ No newline at end of file + condition: service_started + rabbitmq: + condition: service_healthy \ No newline at end of file diff --git a/flags/feature-flags.json b/flags/feature-flags.json index 554b7bc7..0a9ba902 100644 --- a/flags/feature-flags.json +++ b/flags/feature-flags.json @@ -8,6 +8,14 @@ "off": false }, "defaultVariant": "off" + }, + "ENABLE_NEW_ARCHITECTURE": { + "state": "ENABLED", + "variants": { + "on": true, + "off": false + }, + "defaultVariant": "off" } } } diff --git a/pipeline/pom.xml b/pipeline/pom.xml index efc9ba78..927521fd 100644 --- a/pipeline/pom.xml +++ b/pipeline/pom.xml @@ -150,6 +150,11 @@ 0.0.2 + + org.springframework.boot + spring-boot-starter-amqp + + diff --git a/pipeline/src/main/java/com/autobuild/pipeline/configuration/FeatureFlag.java b/pipeline/src/main/java/com/autobuild/pipeline/configuration/FeatureFlag.java index 61fdca40..a258ed4f 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/configuration/FeatureFlag.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/configuration/FeatureFlag.java @@ -2,7 +2,8 @@ /** Enum of all feature flag keys used in this application. */ public enum FeatureFlag { - ENABLE_EDIT_PIPELINE("ENABLE_EDIT_PIPELINE"); + ENABLE_EDIT_PIPELINE("ENABLE_EDIT_PIPELINE"), + ENABLE_NEW_ARCHITECTURE("ENABLE_NEW_ARCHITECTURE"); private final String key; diff --git a/pipeline/src/main/java/com/autobuild/pipeline/configuration/MessagingConfig.java b/pipeline/src/main/java/com/autobuild/pipeline/configuration/MessagingConfig.java new file mode 100644 index 00000000..0c11a454 --- /dev/null +++ b/pipeline/src/main/java/com/autobuild/pipeline/configuration/MessagingConfig.java @@ -0,0 +1,35 @@ +package com.autobuild.pipeline.configuration; + +import org.springframework.amqp.core.Queue; +import org.springframework.amqp.rabbit.connection.ConnectionFactory; +import org.springframework.amqp.rabbit.core.RabbitTemplate; +import org.springframework.amqp.support.converter.Jackson2JsonMessageConverter; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * Message queue configuration. + */ +@Configuration +public class MessagingConfig { + + /** Name of the queue used to dispatch pipeline build execution requests. */ + public static final String PIPELINE_BUILD_REQUEST_QUEUE = "pipeline-build-request-queue"; + + @Bean + public Queue pipelineBuildQueue() { + return new Queue(PIPELINE_BUILD_REQUEST_QUEUE, true); + } + + @Bean + public Jackson2JsonMessageConverter messageConverter() { + return new Jackson2JsonMessageConverter(); + } + + @Bean + public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory) { + RabbitTemplate template = new RabbitTemplate(connectionFactory); + template.setMessageConverter(messageConverter()); + return template; + } +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/controller/PipelineExecutorController.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/controller/PipelineExecutorController.java index a02140f4..c4f91122 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/controller/PipelineExecutorController.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/controller/PipelineExecutorController.java @@ -1,16 +1,16 @@ package com.autobuild.pipeline.executor.controller; -import java.io.IOException; +import java.util.Map; +import java.util.UUID; -import org.springframework.http.MediaType; import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; import com.autobuild.pipeline.executor.dto.PipelineExecuteRequest; import com.autobuild.pipeline.executor.service.PipelineExecutorService; @@ -24,8 +24,6 @@ /** * Controller for executing a pipeline. - * - * @author Suvabrata Chowdhury */ @Tag(name = "Pipeline") @SecurityScheme( @@ -43,12 +41,10 @@ public class PipelineExecutorController { @Autowired private PipelineExecutorService service; - @Operation(summary = "Execute a pipeline", responses = @ApiResponse(responseCode = "203")) + @Operation(summary = "Execute a pipeline", responses = @ApiResponse(responseCode = "202")) @PostMapping(value = "/pipeline", produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity executePipeline(@RequestBody @Valid PipelineExecuteRequest request) - throws IOException { - PipelineBuildDTO build = service.executePipeline(request); - - return ResponseEntity.accepted().body(build); + public ResponseEntity> executePipeline(@RequestBody @Valid PipelineExecuteRequest request) { + UUID buildId = service.executePipeline(request); + return ResponseEntity.accepted().body(Map.of("buildId", buildId)); } } \ No newline at end of file diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/messaging/PipelineBuildRequestMessage.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/messaging/PipelineBuildRequestMessage.java new file mode 100644 index 00000000..08766d11 --- /dev/null +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/messaging/PipelineBuildRequestMessage.java @@ -0,0 +1,25 @@ +package com.autobuild.pipeline.executor.dto.messaging; + +import java.util.List; +import java.util.UUID; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +/** + * Message payload published to the queue when a pipeline execution is requested. + * Contains the pipeline's definition so the executor can process it independently. + */ +@NoArgsConstructor +@AllArgsConstructor +@Getter +@Setter +public class PipelineBuildRequestMessage { + + private UUID buildId; + private UUID pipelineId; + private String pipelineName; + private List stages; +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/messaging/StageDefinition.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/messaging/StageDefinition.java new file mode 100644 index 00000000..7e43ef25 --- /dev/null +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/messaging/StageDefinition.java @@ -0,0 +1,21 @@ +package com.autobuild.pipeline.executor.dto.messaging; + +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +/** + * Represents a single stage within a pipeline build request message. + */ +@NoArgsConstructor +@AllArgsConstructor +@Getter +@Setter +public class StageDefinition { + + private String name; + private String scriptType; + private String command; + private int stageOrder; +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/messaging/PipelineBuildMessagePublisher.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/messaging/PipelineBuildMessagePublisher.java new file mode 100644 index 00000000..c745963a --- /dev/null +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/messaging/PipelineBuildMessagePublisher.java @@ -0,0 +1,16 @@ +package com.autobuild.pipeline.executor.messaging; + +import com.autobuild.pipeline.executor.dto.messaging.PipelineBuildRequestMessage; + +/** + * Contract for publishing pipeline build request messages to a message queue. + */ +public interface PipelineBuildMessagePublisher { + + /** + * Publishes a pipeline build request message. + * + * @param message the build request containing the pipeline definition and generated build ID + */ + void publish(PipelineBuildRequestMessage message); +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/messaging/RabbitMqPipelineBuildMessagePublisher.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/messaging/RabbitMqPipelineBuildMessagePublisher.java new file mode 100644 index 00000000..156b367f --- /dev/null +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/messaging/RabbitMqPipelineBuildMessagePublisher.java @@ -0,0 +1,28 @@ +package com.autobuild.pipeline.executor.messaging; + +import org.springframework.amqp.rabbit.core.RabbitTemplate; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import com.autobuild.pipeline.configuration.MessagingConfig; +import com.autobuild.pipeline.executor.dto.messaging.PipelineBuildRequestMessage; + +import lombok.extern.slf4j.Slf4j; + +/** + * RabbitMQ implementation of {@link PipelineBuildMessagePublisher}. + */ +@Slf4j +@Service +public class RabbitMqPipelineBuildMessagePublisher implements PipelineBuildMessagePublisher { + + @Autowired + private RabbitTemplate rabbitTemplate; + + @Override + public void publish(PipelineBuildRequestMessage message) { + rabbitTemplate.convertAndSend(MessagingConfig.PIPELINE_BUILD_REQUEST_QUEUE, message); + log.info("Published build request {} to queue '{}'", + message.getBuildId(), MessagingConfig.PIPELINE_BUILD_REQUEST_QUEUE); + } +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/repository/PipelineBuildRepository.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/repository/PipelineBuildRepository.java index 00741a86..e8fd955b 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/repository/PipelineBuildRepository.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/repository/PipelineBuildRepository.java @@ -9,8 +9,6 @@ /** * Repository layer for PipelineBuild. - * - * @author Suvabrata Chowdhury */ @Repository diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineExecutorService.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineExecutorService.java index 53dcbac3..e4836d85 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineExecutorService.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineExecutorService.java @@ -1,38 +1,28 @@ package com.autobuild.pipeline.executor.service; -import java.io.IOException; import java.util.List; import java.util.Optional; import java.util.UUID; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; -import org.springframework.transaction.annotation.Transactional; -import org.springframework.transaction.support.TransactionSynchronization; -import org.springframework.transaction.support.TransactionSynchronizationManager; +import com.autobuild.pipeline.configuration.FeatureFlag; +import com.autobuild.pipeline.configuration.FeatureFlagService; import com.autobuild.pipeline.definiton.entity.Pipeline; import com.autobuild.pipeline.definiton.repository.PipelineRepository; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; import com.autobuild.pipeline.executor.dto.PipelineExecuteRequest; -import com.autobuild.pipeline.executor.dto.mapper.PipelineBuildMapper; -import com.autobuild.pipeline.executor.entity.PipelineBuild; -import com.autobuild.pipeline.executor.entity.StageBuild; +import com.autobuild.pipeline.executor.dto.messaging.PipelineBuildRequestMessage; +import com.autobuild.pipeline.executor.dto.messaging.StageDefinition; import com.autobuild.pipeline.executor.job.PipelineExecutor; -import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; -import com.autobuild.pipeline.utility.file.PipelineFileService; +import com.autobuild.pipeline.executor.messaging.PipelineBuildMessagePublisher; import jakarta.persistence.EntityNotFoundException; import lombok.extern.slf4j.Slf4j; /** - * Service layer for executing a pipeline. - * - * @author Suvabrata Chowdhury + * Service layer for triggering pipeline execution. */ - -//TODO: too much dependencies. refactor - @Slf4j @Service public class PipelineExecutorService { @@ -41,19 +31,23 @@ public class PipelineExecutorService { private PipelineRepository pipelineRepository; @Autowired - private PipelineBuildRepository buildRepository; - - @Autowired - private PipelineExecutor pipelineExecutor; + private FeatureFlagService featureFlagService; @Autowired - private PipelineBuildMapper mapper; + private PipelineBuildMessagePublisher messagePublisher; @Autowired - private PipelineFileService pipelineFileService; + private PipelineExecutor pipelineExecutor; - @Transactional - public PipelineBuildDTO executePipeline(PipelineExecuteRequest pipelineRequest) throws IOException { + /** + * Triggers execution of a pipeline. + * When the message queue flag is enabled, publishes the pipeline definition to the queue. + * Otherwise falls back to direct execution. + * + * @param pipelineRequest the execution request containing the pipeline ID + * @return the generated build ID + */ + public UUID executePipeline(PipelineExecuteRequest pipelineRequest) { UUID pipelineId = pipelineRequest.getPipelineId(); Optional optionalPipeline = pipelineRepository.findById(pipelineId); @@ -63,47 +57,28 @@ public PipelineBuildDTO executePipeline(PipelineExecuteRequest pipelineRequest) } Pipeline pipeline = optionalPipeline.get(); - PipelineBuild pipelineBuild = createBuild(pipeline); - - createEmptyLogFiles(pipelineBuild); - - PipelineBuild savedBuild = buildRepository.save(pipelineBuild); + UUID buildId = UUID.randomUUID(); - // Strictly run executing pipeline after build is commited - TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() { - @Override - public void afterCommit() { - pipelineExecutor.executePipeline(savedBuild); - } - }); - - return mapper.entityToDto(savedBuild); - } - - private void createEmptyLogFiles(PipelineBuild pipelineBuild) throws IOException { - for (StageBuild stageBuild : pipelineBuild.getStageBuilds()) { - try { - stageBuild.setLogPath(pipelineFileService.createLogFile(pipelineBuild.getId(), stageBuild.getId())); - } catch (IOException e) { - pipelineFileService.removeLogFiles(pipelineBuild); - } + if (featureFlagService.getBooleanValue(FeatureFlag.ENABLE_NEW_ARCHITECTURE.getKey())) { + PipelineBuildRequestMessage message = buildMessage(buildId, pipeline); + messagePublisher.publish(message); + } else { + pipelineExecutor.executePipeline(null); } - } - // TODO: abstract this logic - private PipelineBuild createBuild(final Pipeline pipeline) { - List stageBuilds = pipeline.getStages() - .stream() - .map(stage -> { - StageBuild stageBuild = new StageBuild(stage); - stageBuild.setId(UUID.randomUUID()); - - return stageBuild; - }).toList(); - - PipelineBuild pipelineBuild = new PipelineBuild(pipeline, stageBuilds); - pipelineBuild.setId(UUID.randomUUID()); + return buildId; + } - return pipelineBuild; + private PipelineBuildRequestMessage buildMessage(UUID buildId, Pipeline pipeline) { + List stages = pipeline.getStages() + .stream() + .map(stage -> new StageDefinition( + stage.getName(), + stage.getScriptType(), + stage.getPath(), + stage.getStageOrder())) + .toList(); + + return new PipelineBuildRequestMessage(buildId, pipeline.getId(), pipeline.getName(), stages); } -} \ No newline at end of file +} diff --git a/pipeline/src/main/resources/application-demo.yaml b/pipeline/src/main/resources/application-demo.yaml index bb4b83d0..a33eb416 100644 --- a/pipeline/src/main/resources/application-demo.yaml +++ b/pipeline/src/main/resources/application-demo.yaml @@ -29,6 +29,9 @@ spring: exclude: - org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration + rabbitmq: + addresses: ${RABBITMQ_URL:amqp://guest:guest@localhost:5672} + feature-flags: provider: uri: ${FEATURE_PROVIDER_URI:} diff --git a/pipeline/src/main/resources/application-test.yaml b/pipeline/src/main/resources/application-test.yaml index 89a9863a..105b869a 100644 --- a/pipeline/src/main/resources/application-test.yaml +++ b/pipeline/src/main/resources/application-test.yaml @@ -22,6 +22,7 @@ spring: exclude: - org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration - org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration + - org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration feature-flags: provider: diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/controller/PipelineExecutorControllerTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/controller/PipelineExecutorControllerTest.java index 100339b4..5b8b3a69 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/controller/PipelineExecutorControllerTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/controller/PipelineExecutorControllerTest.java @@ -3,12 +3,12 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.doReturn; import static org.mockito.Mockito.doThrow; -import java.io.IOException; +import java.util.Map; +import java.util.UUID; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -18,12 +18,15 @@ import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; import com.autobuild.pipeline.executor.dto.PipelineExecuteRequest; import com.autobuild.pipeline.executor.service.PipelineExecutorService; import com.autobuild.pipeline.testutility.DummyData; +/** + * Unit tests for {@link PipelineExecutorController}. + */ public class PipelineExecutorControllerTest { + @Mock private PipelineExecutorService service; @@ -31,35 +34,29 @@ public class PipelineExecutorControllerTest { private PipelineExecutorController controller; private PipelineExecuteRequest executeRequest = DummyData.getPipelineRequest(); - private PipelineBuildDTO pipelineBuildDTO = DummyData.getPipelineBuildDTO(executeRequest.getPipelineId()); + private UUID buildId = UUID.randomUUID(); @BeforeEach - public void setUp() throws IOException { + public void setUp() { MockitoAnnotations.openMocks(this); - - doReturn(pipelineBuildDTO).when(service).executePipeline(executeRequest); + doReturn(buildId).when(service).executePipeline(executeRequest); } @Test - public void testExecutePipeline() throws IOException { - ResponseEntity response = controller.executePipeline(executeRequest); - + public void testExecutePipeline() { + ResponseEntity> response = controller.executePipeline(executeRequest); + assertNotNull(response); assertEquals(HttpStatus.ACCEPTED, response.getStatusCode()); - - PipelineBuildDTO responseDto = response.getBody(); - - assertNotNull(responseDto); - assertEquals(executeRequest.getPipelineId(), responseDto.getPipelineId()); - - assertNotNull(responseDto.getStageBuilds()); - assertTrue(responseDto.getStageBuilds().size() > 0); + assertNotNull(response.getBody()); + assertEquals(buildId, response.getBody().get("buildId")); } @Test - public void testExecutePipelineRuntimeError() throws IOException { - doThrow(new RuntimeException("Something runtime exception")).when(service).executePipeline(any(PipelineExecuteRequest.class)); + public void testExecutePipelineRuntimeError() { + doThrow(new RuntimeException("Something runtime exception")) + .when(service).executePipeline(any(PipelineExecuteRequest.class)); - assertThrows(RuntimeException.class,() -> controller.executePipeline(executeRequest)); + assertThrows(RuntimeException.class, () -> controller.executePipeline(executeRequest)); } } diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineExecutorServiceTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineExecutorServiceTest.java index ef00bba1..abe76ab8 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineExecutorServiceTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineExecutorServiceTest.java @@ -1,14 +1,13 @@ package com.autobuild.pipeline.executor.service; -import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.Mockito.doReturn; -import static org.mockito.Mockito.mockStatic; +import static org.mockito.Mockito.never; import static org.mockito.Mockito.times; import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; -import java.io.IOException; import java.util.Optional; import java.util.UUID; @@ -16,71 +15,85 @@ import org.junit.jupiter.api.Test; import org.mockito.InjectMocks; import org.mockito.Mock; -import org.mockito.MockedStatic; import org.mockito.MockitoAnnotations; -import org.springframework.transaction.support.TransactionSynchronizationManager; +import com.autobuild.pipeline.configuration.FeatureFlagService; import com.autobuild.pipeline.definiton.entity.Pipeline; import com.autobuild.pipeline.definiton.repository.PipelineRepository; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; import com.autobuild.pipeline.executor.dto.PipelineExecuteRequest; -import com.autobuild.pipeline.executor.dto.mapper.PipelineBuildMapper; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.dto.messaging.PipelineBuildRequestMessage; import com.autobuild.pipeline.executor.job.PipelineExecutor; -import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; +import com.autobuild.pipeline.executor.messaging.PipelineBuildMessagePublisher; import com.autobuild.pipeline.testutility.DummyData; -import com.autobuild.pipeline.utility.file.PipelineFileService; +import jakarta.persistence.EntityNotFoundException; + +/** + * Unit tests for {@link PipelineExecutorService}. + */ public class PipelineExecutorServiceTest { @Mock private PipelineRepository pipelineRepository; @Mock - private PipelineBuildRepository pipelineBuildRepository; - - @Mock - private PipelineExecutor pipelineExecutor; + private FeatureFlagService featureFlagService; @Mock - private PipelineBuildMapper pipelineBuildMapper; + private PipelineBuildMessagePublisher messagePublisher; @Mock - private PipelineFileService pipelineFileService; + private PipelineExecutor pipelineExecutor; @InjectMocks private PipelineExecutorService pipelineExecutorService; - private PipelineBuildDTO pipelineBuildDTO = DummyData.getPipelineBuildDTO(); - @BeforeEach public void setup() { MockitoAnnotations.openMocks(this); } @Test - public void executePipelineTest() throws IOException { + public void executePipeline_whenFlagEnabled_publishesMessageAndReturnsBuildId() { UUID pipelineId = UUID.randomUUID(); + Pipeline pipeline = DummyData.getPipeline(pipelineId); + PipelineExecuteRequest request = new PipelineExecuteRequest(pipelineId); + + when(pipelineRepository.findById(pipelineId)).thenReturn(Optional.of(pipeline)); + when(featureFlagService.getBooleanValue(any())).thenReturn(true); + UUID buildId = pipelineExecutorService.executePipeline(request); + + assertNotNull(buildId); + verify(messagePublisher, times(1)).publish(any(PipelineBuildRequestMessage.class)); + verify(pipelineExecutor, never()).executePipeline(any()); + } + + @Test + public void executePipeline_whenFlagDisabled_callsDirectExecutor() { + UUID pipelineId = UUID.randomUUID(); Pipeline pipeline = DummyData.getPipeline(pipelineId); + PipelineExecuteRequest request = new PipelineExecuteRequest(pipelineId); - PipelineExecuteRequest pipelineExecuteRequest = new PipelineExecuteRequest(pipelineId); - PipelineBuild pipelineBuild = DummyData.getPipelineBuild(pipelineId); - PipelineBuildDTO pipelineBuildDTO = DummyData.getPipelineBuildDTO(pipelineId); + when(pipelineRepository.findById(pipelineId)).thenReturn(Optional.of(pipeline)); + when(featureFlagService.getBooleanValue(any())).thenReturn(false); - doReturn(Optional.of(pipeline)).when(pipelineRepository).findById(any(UUID.class)); - doReturn(pipelineBuild).when(pipelineBuildRepository).save(any(PipelineBuild.class)); - doReturn(pipelineBuildDTO).when(pipelineBuildMapper).entityToDto(pipelineBuild); + UUID buildId = pipelineExecutorService.executePipeline(request); - try (MockedStatic transactionSynMockedStatic = mockStatic( - TransactionSynchronizationManager.class)) { - PipelineBuildDTO resultantDTO = pipelineExecutorService.executePipeline(pipelineExecuteRequest); + assertNotNull(buildId); + verify(messagePublisher, never()).publish(any()); + verify(pipelineExecutor, times(1)).executePipeline(any()); + } - assertEquals(pipelineExecuteRequest.getPipelineId(), resultantDTO.getPipelineId()); + @Test + public void executePipeline_whenPipelineNotFound_throwsEntityNotFoundException() { + UUID pipelineId = UUID.randomUUID(); + PipelineExecuteRequest request = new PipelineExecuteRequest(pipelineId); - verify(pipelineRepository, times(1)).findById(eq(pipelineId)); - verify(pipelineBuildRepository, times(1)).save(any(PipelineBuild.class)); + when(pipelineRepository.findById(pipelineId)).thenReturn(Optional.empty()); - } + assertThrows(EntityNotFoundException.class, () -> pipelineExecutorService.executePipeline(request)); + verify(messagePublisher, never()).publish(any()); + verify(pipelineExecutor, never()).executePipeline(any()); } } diff --git a/pipeline/src/test/java/com/autobuild/pipeline/testutility/DummyData.java b/pipeline/src/test/java/com/autobuild/pipeline/testutility/DummyData.java index 709c2bd0..fffe7c36 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/testutility/DummyData.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/testutility/DummyData.java @@ -10,6 +10,8 @@ import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; import com.autobuild.pipeline.executor.dto.PipelineExecuteRequest; import com.autobuild.pipeline.executor.dto.StageBuildDTO; +import com.autobuild.pipeline.executor.dto.messaging.PipelineBuildRequestMessage; +import com.autobuild.pipeline.executor.dto.messaging.StageDefinition; import com.autobuild.pipeline.executor.entity.PipelineBuild; import com.autobuild.pipeline.executor.entity.StageBuild; import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; @@ -66,4 +68,9 @@ public static PipelineBuildDTO getPipelineBuildDTO() { public static PipelineBuildDTO getPipelineBuildDTO(UUID pipelineId) { return new PipelineBuildDTO(UUID.randomUUID(), pipelineId, "Dummy Pipeline", PipelineExecutionState.WAITING, List.of(DummyData.getStageBuildDTO())); } + + public static PipelineBuildRequestMessage getPipelineBuildRequestMessage(UUID pipelineId) { + StageDefinition stage = new StageDefinition("dummyStage1", "bash", "./dummyFolder/", 0); + return new PipelineBuildRequestMessage(UUID.randomUUID(), pipelineId, "my pipeline", List.of(stage)); + } } \ No newline at end of file