diff --git a/.gitignore b/.gitignore index 1210cc70c..eb58f6ac8 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,7 @@ pipeline_build_logs/* .vscode/* # Bazel symlinks — point into the local cache, machine-specific -/bazel-* \ No newline at end of file +/bazel-* + +# Protobuf generated files +**/definiton/gen/ diff --git a/Dockerfile b/Dockerfile index d774eafef..969363a90 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,10 +1,11 @@ # # Build stage # -FROM maven:3.8.3-openjdk-17 AS build +FROM maven:3.9.6-eclipse-temurin-17 AS build WORKDIR /home/app COPY pipeline/pom.xml . COPY pipeline/src ./src +COPY apis/protobuf /home/apis/protobuf RUN mvn clean package -DskipTests -Pmonitoring # diff --git a/apis/openapi-spec/pipeline-service.yaml b/apis/openapi-spec/pipeline-service.yaml index 886fa1cab..fbfdff565 100644 --- a/apis/openapi-spec/pipeline-service.yaml +++ b/apis/openapi-spec/pipeline-service.yaml @@ -249,35 +249,32 @@ components: properties: id: type: string - format: uuid name: type: string stages: type: array items: $ref: "#/components/schemas/Stage" - required: - - name - - stages - Stage: + PipelineBuild: type: object properties: - id: + currentState: type: string - format: uuid - name: + enum: + - WAITING + - RUNNING + - SUCCESS + - FAILED + id: type: string - scriptType: + pipelineId: type: string - command: + pipelineName: type: string - stageOrder: - type: integer - format: int32 - required: - - command - - name - - scriptType + stageBuilds: + type: array + items: + $ref: "#/components/schemas/StageBuild" PipelineExecuteRequest: type: object properties: @@ -286,17 +283,23 @@ components: format: uuid required: - pipelineId - PipelineBuild: + Stage: type: object properties: + command: + type: string id: type: string - format: uuid - pipelineId: + name: type: string - format: uuid - pipelineName: + scriptType: type: string + stageOrder: + type: integer + format: int32 + StageBuild: + type: object + properties: currentState: type: string enum: @@ -304,35 +307,16 @@ components: - RUNNING - SUCCESS - FAILED - startedAt: - type: string - format: date-time - stageBuilds: - type: array - items: - $ref: "#/components/schemas/StageBuild" - StageBuild: - type: object - properties: + - STOPPED id: type: string - format: uuid stageId: type: string - format: uuid stageName: type: string stageOrder: type: integer format: int32 - currentState: - type: string - enum: - - WAITING - - RUNNING - - SUCCESS - - FAILED - - STOPPED securitySchemes: bearerAuth: type: http diff --git a/apis/protobuf/BUILD.bazel b/apis/protobuf/BUILD.bazel new file mode 100644 index 000000000..07a3840f1 --- /dev/null +++ b/apis/protobuf/BUILD.bazel @@ -0,0 +1,5 @@ +filegroup( + name = "protobuf_files", + srcs = glob(["**/*.proto"]), + visibility = ["//visibility:public"], +) \ No newline at end of file diff --git a/apis/protobuf/buf.yaml b/apis/protobuf/buf.yaml new file mode 100644 index 000000000..31ebbb9a2 --- /dev/null +++ b/apis/protobuf/buf.yaml @@ -0,0 +1 @@ +version: v2 \ No newline at end of file diff --git a/apis/protobuf/definition/v1/pipeline_definition.proto b/apis/protobuf/definition/v1/pipeline_definition.proto new file mode 100644 index 000000000..91d4c1c73 --- /dev/null +++ b/apis/protobuf/definition/v1/pipeline_definition.proto @@ -0,0 +1,23 @@ +syntax = "proto3"; + +package definition.v1; + +option java_package = "com.autobuild.pipeline.definiton.gen.dto"; +option java_multiple_files = true; + +// option go_package = ""; +// go_multiple_files doesn't exist - Go always generates one file per proto file. + +message Stage { + string id = 1; + string name = 2; + string script_type = 3; + string command = 4; + int32 stage_order = 5; +} + +message Pipeline { + string id = 1; + string name = 2; + repeated Stage stages = 3; +} \ No newline at end of file diff --git a/apis/protobuf/execution/v1/pipeline_execution.proto b/apis/protobuf/execution/v1/pipeline_execution.proto new file mode 100644 index 000000000..fe5b7d7bd --- /dev/null +++ b/apis/protobuf/execution/v1/pipeline_execution.proto @@ -0,0 +1,49 @@ +syntax = "proto3"; + +package execution.v1; + +import "google/protobuf/timestamp.proto"; + +option java_package = "com.autobuild.pipeline.executor.gen.dto"; +option java_multiple_files = true; + +// option go_package = ""; +// go_multiple_files doesn't exist - Go always generates one file per proto file. + +enum PipelineExecutionState { + PIPELINE_WAITING = 0; // Pipeline is waiting to be executed. + PIPELINE_RUNNING = 1; // Pipeline execution has started. + PIPELINE_SUCCESS = 2; // Pipeline execution has finished and it succeeded. + PIPELINE_FAILED = 3; // Pipeline execution has finished and it failed. +} + +enum StageExecutionState { + STAGE_WAITING = 0; // Stage is waiting to be executed. + STAGE_RUNNING = 1; // Stage execution has started. + STAGE_SUCCESS = 2; // Stage execution has finished and it succeeded. + STAGE_FAILED = 3; // Stage execution has finished and it failed. + STAGE_STOPPED = 4; // Stage execution stopped. +} + +message StageBuild { + string id = 1; + string stage_id = 2; + string stage_name = 3; + StageExecutionState current_state = 4; + int32 stage_order = 5; +} + +message PipelineBuild { + string id = 1; + string pipeline_id = 2; + string pipeline_name = 3; + PipelineExecutionState current_state = 4; + repeated StageBuild stage_builds = 5; + google.protobuf.Timestamp started_at = 6; +} + +// A single line of output from a running stage, streamed back as it is produced. +message StageLog { + string stage_build_id = 1; + string line = 2; +} diff --git a/autobuild-docs/setup/backend/local-backend-execution.md b/autobuild-docs/setup/backend/local-backend-execution.md index 6982fdaac..32df47aef 100644 --- a/autobuild-docs/setup/backend/local-backend-execution.md +++ b/autobuild-docs/setup/backend/local-backend-execution.md @@ -4,4 +4,15 @@ 1. Locate [backend launch.json](https://github.com/SuvabrataChowdhury/AutoBuild/blob/launch-json-template/pipeline/.vscode/launch.json.template) and rename it to just `launch.json`. 2. From VS Code `Run and Debug` (keybind SHIFT+CMD+D for Mac) select `AutoBuild: Local` and run the backend service in debug mode. ![VS Code Execution](./images/vs-code-execution.png) - Ensure the application is running fine by hitting the endpoints through bruno. \ No newline at end of file + Ensure the application is running fine by hitting the endpoints through bruno. + + +3. [Optional] To generate Protobuf classes locally: + From the `pipeline/` directory, run: `mvn compile -s maven-settings.xml` + Without `-s maven-settings.xml`, Maven falls back to repository mentioned at `~/.m2/repository/settings.xml` and might fail if it does not have the necessary dependencies. Mentioning it like that ensures the dependencies are pulled from open maven repository. + (The files are generated at the `generate-sources` and writes the Java files into target/generated-sources/. Then compile picks them up alongside your hand-written code and compiles everything together.) +4. Recommended VS Code extension for .proto files: + **Buf** (`bufbuild.vscode-buf`) — syntax highlighting and linting + https://marketplace.visualstudio.com/items?itemName=bufbuild.vscode-buf +5. To understand Protocol Buffers (the format used for DTO generation): + Protocol Buffers Crash Course — https://youtu.be/46O73On0gyI diff --git a/autobuild-docs/setup/backend/running-backend-containers.md b/autobuild-docs/setup/backend/running-backend-containers.md index 2d73167a3..1e529dc9a 100644 --- a/autobuild-docs/setup/backend/running-backend-containers.md +++ b/autobuild-docs/setup/backend/running-backend-containers.md @@ -51,3 +51,7 @@ docker compose -p autobuild down docker compose down -v ``` > Note: this will delete all persisted volumes including database data, Grafana dashboards, Loki logs, and Prometheus metrics. + +## Protobuf + +Proto classes are auto-generated during `docker build` — Maven runs the protobuf compiler as part of the build, so no separate step is needed. diff --git a/pipeline/BUILD.bazel b/pipeline/BUILD.bazel index c2f613b42..427ad06d5 100644 --- a/pipeline/BUILD.bazel +++ b/pipeline/BUILD.bazel @@ -3,9 +3,9 @@ load("@rules_shell//shell:sh_test.bzl", "sh_test") # Inputs Bazel tracks for cache invalidation — if none of these change, # both targets below are skipped entirely (cache hit). _SRCS = glob( - ["src/**", "pom.xml", "checkstyle.xml"], + ["src/**", "pom.xml", "checkstyle.xml", "maven-settings.xml"], exclude = ["target/**"], -) +) + ["//apis/protobuf:protobuf_files"] # Runs the full Maven test suite. # Run with: bazel test //pipeline:test @@ -13,7 +13,7 @@ sh_test( name = "test", srcs = ["run_tests.sh"], data = _SRCS, - tags = [], + tags = ["local"], ) # Generates the OpenAPI spec by starting the app and hitting /v3/api-docs.yaml. diff --git a/pipeline/maven-settings.xml b/pipeline/maven-settings.xml new file mode 100644 index 000000000..5d17a89b4 --- /dev/null +++ b/pipeline/maven-settings.xml @@ -0,0 +1,4 @@ + + \ No newline at end of file diff --git a/pipeline/pom.xml b/pipeline/pom.xml index 933f89e08..b6abdaf00 100644 --- a/pipeline/pom.xml +++ b/pipeline/pom.xml @@ -28,6 +28,7 @@ 17 + 4.29.3 @@ -156,6 +157,18 @@ spring-boot-starter-graphql + + com.google.protobuf + protobuf-java + ${protobuf.version} + + + + com.google.protobuf + protobuf-java-util + ${protobuf.version} + + @@ -202,6 +215,7 @@ UTF-8 true true + true @@ -224,6 +238,9 @@ 0.8.15 + + com/autobuild/pipeline/**/gen/** + BUNDLE @@ -261,8 +278,31 @@ check + + ${skipTests} + + + + io.github.ascopes + protobuf-maven-plugin + 5.1.11 + + + ${protobuf.version} + + + ${project.basedir}/../apis/protobuf + + + + + + generate + + + diff --git a/pipeline/run_generate_openapi.sh b/pipeline/run_generate_openapi.sh index 3ebf78d79..f76c203b5 100755 --- a/pipeline/run_generate_openapi.sh +++ b/pipeline/run_generate_openapi.sh @@ -2,4 +2,4 @@ set -euo pipefail cd "./pipeline/" -mvn --batch-mode verify -P integration-test -DskipTests +mvn --batch-mode -s maven-settings.xml verify -P integration-test -DskipTests diff --git a/pipeline/run_tests.sh b/pipeline/run_tests.sh index ef8f9120f..05a3b474e 100755 --- a/pipeline/run_tests.sh +++ b/pipeline/run_tests.sh @@ -2,4 +2,4 @@ set -euo pipefail cd "./pipeline/" -mvn --batch-mode clean verify +mvn --batch-mode -s maven-settings.xml clean verify diff --git a/pipeline/src/main/java/com/autobuild/pipeline/configuration/MapperConfig.java b/pipeline/src/main/java/com/autobuild/pipeline/configuration/MapperConfig.java deleted file mode 100644 index 87588b57d..000000000 --- a/pipeline/src/main/java/com/autobuild/pipeline/configuration/MapperConfig.java +++ /dev/null @@ -1,116 +0,0 @@ -package com.autobuild.pipeline.configuration; - -import org.modelmapper.ModelMapper; -import org.modelmapper.TypeMap; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; - -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.dto.StageDTO; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.definiton.entity.Stage; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; -import com.autobuild.pipeline.executor.dto.StageBuildDTO; -import com.autobuild.pipeline.executor.entity.PipelineBuild; -import com.autobuild.pipeline.executor.entity.StageBuild; - -/** - * Bean Configurations for the application. - * - * @author Suvabrata Chowdhury - */ - -@Configuration -public class MapperConfig { - @Bean - public ModelMapper getModelMapper() { - ModelMapper mapper = new ModelMapper(); - - setStageMappings(mapper); - setPipelineMapping(mapper); - - setStageBuildMappings(mapper); - setPipelineBuildMappings(mapper); - - return mapper; - } - - private void setStageMappings(ModelMapper mapper) { - setStageDTOEntityMapping(mapper); - setStageEntityDTOMapping(mapper); - } - - private void setStageDTOEntityMapping(ModelMapper mapper) { - TypeMap typeMapper = mapper.createTypeMap(StageDTO.class, Stage.class); - typeMapper.addMapping(StageDTO::getId, Stage::setId); - typeMapper.addMapping(StageDTO::getName, Stage::setName); - typeMapper.addMapping(StageDTO::getScriptType, Stage::setScriptType); - } - - private void setStageEntityDTOMapping(ModelMapper mapper) { - TypeMap typeMapper = mapper.createTypeMap(Stage.class, StageDTO.class); - typeMapper.addMapping(Stage::getId, StageDTO::setId); - typeMapper.addMapping(Stage::getName, StageDTO::setName); - typeMapper.addMapping(Stage::getScriptType, StageDTO::setScriptType); - } - - private void setPipelineMapping(ModelMapper mapper) { - setPipelineDTOEntityMapping(mapper); - setPipelineEntityDTOMapping(mapper); - } - - private void setPipelineDTOEntityMapping(ModelMapper mapper) { - TypeMap typeMapper = mapper.createTypeMap(PipelineDTO.class, Pipeline.class); - typeMapper.addMapping(PipelineDTO::getId, Pipeline::setId); - typeMapper.addMapping(PipelineDTO::getName, Pipeline::setName); - } - - private void setPipelineEntityDTOMapping(ModelMapper mapper) { - TypeMap typeMapper = mapper.createTypeMap(Pipeline.class, PipelineDTO.class); - typeMapper.addMapping(Pipeline::getName, PipelineDTO::setName); - typeMapper.addMapping(Pipeline::getId, PipelineDTO::setId); - } - - private void setStageBuildMappings(ModelMapper mapper) { - setStageBuildEntityDTOMapping(mapper); - setStageBuildDTOEntityMapping(mapper); - } - - private void setStageBuildEntityDTOMapping(ModelMapper mapper) { - TypeMap typeMapper = mapper.createTypeMap(StageBuild.class, StageBuildDTO.class); - typeMapper.addMapping(StageBuild::getId, StageBuildDTO::setId); - typeMapper.addMapping(stageBuild -> stageBuild.getStage().getId(), StageBuildDTO::setStageId); - typeMapper.addMapping(stageBuild -> stageBuild.getStage().getName(), StageBuildDTO::setStageName); - typeMapper.addMapping(stageBuild -> stageBuild.getStage().getStageOrder(), StageBuildDTO::setStageOrder); - typeMapper.addMapping(StageBuild::getCurrentState, StageBuildDTO::setCurrentState); - } - - private void setStageBuildDTOEntityMapping(ModelMapper mapper) { - TypeMap typeMapper = mapper.createTypeMap(StageBuildDTO.class, StageBuild.class); - typeMapper.addMapping(StageBuildDTO::getId, StageBuild::setId); - typeMapper.addMapping(StageBuildDTO::getCurrentState, StageBuild::setCurrentState); - } - - private void setPipelineBuildMappings(ModelMapper mapper) { - setPipelineBuildEntityDTOMapping(mapper); - setPipelineBuildDTOEntityMapping(mapper); - } - - private void setPipelineBuildEntityDTOMapping(ModelMapper mapper) { - TypeMap typeMapper = mapper.createTypeMap(PipelineBuild.class, - PipelineBuildDTO.class); - typeMapper.addMapping(PipelineBuild::getId, PipelineBuildDTO::setId); - typeMapper.addMapping(pipelineBuild -> pipelineBuild.getPipeline().getId(), PipelineBuildDTO::setPipelineId); - typeMapper.addMapping(pipelineBuild -> pipelineBuild.getPipeline().getName(), - PipelineBuildDTO::setPipelineName); - typeMapper.addMapping(PipelineBuild::getCurrentState, PipelineBuildDTO::setCurrentState); - typeMapper.addMapping(PipelineBuild::getStartedAt, PipelineBuildDTO::setStartedAt); - } - - private void setPipelineBuildDTOEntityMapping(ModelMapper mapper) { - TypeMap typeMapper = mapper.createTypeMap(PipelineBuildDTO.class, - PipelineBuild.class); - typeMapper.addMapping(PipelineBuildDTO::getId, PipelineBuild::setId); - typeMapper.addMapping(PipelineBuildDTO::getCurrentState, PipelineBuild::setCurrentState); - } -} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/configuration/ProtobufConfig.java b/pipeline/src/main/java/com/autobuild/pipeline/configuration/ProtobufConfig.java new file mode 100644 index 000000000..f595228b2 --- /dev/null +++ b/pipeline/src/main/java/com/autobuild/pipeline/configuration/ProtobufConfig.java @@ -0,0 +1,54 @@ +package com.autobuild.pipeline.configuration; + +import java.io.IOException; + +import org.springframework.boot.autoconfigure.jackson.Jackson2ObjectMapperBuilderCustomizer; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.MediaType; +import org.springframework.http.converter.protobuf.ProtobufJsonFormatHttpMessageConverter; + +import com.fasterxml.jackson.core.JsonGenerator; +import com.fasterxml.jackson.databind.JsonSerializer; +import com.fasterxml.jackson.databind.SerializerProvider; +import com.google.protobuf.Message; +import com.google.protobuf.util.JsonFormat; + +/** + * Configures protobuf serialization and deserialization for Spring MVC. + * + * {@link org.springframework.http.converter.protobuf.ProtobufJsonFormatHttpMessageConverter} + * is registered read-only so Jackson handles all serialization. The Jackson customizer + * strips proto enum prefixes (PIPELINE_RUNNING → RUNNING) to match the OpenAPI spec. + */ +@Configuration +public class ProtobufConfig { + + // Read-only: handles JSON deserialization of proto request bodies. + // canWrite is disabled so Jackson handles all serialization — this allows + // the Jackson customizer below to strip enum prefixes (PIPELINE_RUNNING → RUNNING). + @Bean + public ProtobufJsonFormatHttpMessageConverter protobufJsonFormatHttpMessageConverter() { + return new ProtobufJsonFormatHttpMessageConverter() { + @Override + public boolean canWrite(Class clazz, MediaType mediaType) { + return false; + } + }; + } + + @Bean + public Jackson2ObjectMapperBuilderCustomizer protobufJacksonCustomizer() { + return builder -> builder.serializerByType(Message.class, new JsonSerializer() { + @Override + public void serialize(Message message, JsonGenerator gen, SerializerProvider serializers) + throws IOException { + String json = JsonFormat.printer().omittingInsignificantWhitespace().print(message); + // Strip enum prefixes so the JSON matches the OpenAPI spec: + // PIPELINE_RUNNING → RUNNING, STAGE_RUNNING → RUNNING + json = json.replaceAll("\"(PIPELINE_|STAGE_)([A-Z_]+)\"", "\"$2\""); + gen.writeRawValue(json); + } + }); + } +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/configuration/ProtobufOpenApiCustomizer.java b/pipeline/src/main/java/com/autobuild/pipeline/configuration/ProtobufOpenApiCustomizer.java new file mode 100644 index 000000000..b74106272 --- /dev/null +++ b/pipeline/src/main/java/com/autobuild/pipeline/configuration/ProtobufOpenApiCustomizer.java @@ -0,0 +1,119 @@ +package com.autobuild.pipeline.configuration; + +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.TreeMap; + +import org.springdoc.core.customizers.OpenApiCustomizer; +import org.springframework.stereotype.Component; + +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.media.Schema; + +/** + * Cleans up the generated OpenAPI spec from proto internals. + * + * Proto-generated classes expose many framework internals (Descriptor, ByteString, Parser, etc.) + * via reflection. Springdoc picks these up and adds them to the spec. Problems caused: + * 1. Non-determinism: HashMap iteration order changes each JVM run → CI "spec out of sync" fails. + * 2. Wrong field names: proto uses getStageBuildsList() → "stageBuildsList"; frontend expects "stageBuilds". + * 3. Prefixed enum values: proto uses PIPELINE_SUCCESS, STAGE_SUCCESS; frontend expects SUCCESS. + * + * This customizer runs after spec generation and fixes all three. + */ +@Component +public class ProtobufOpenApiCustomizer implements OpenApiCustomizer { + + private static final Set KEEP_SCHEMAS = Set.of( + "Pipeline", + "PipelineBuild", + "PipelineExecuteRequest", + "Stage", + "StageBuild" + ); + + // Only the business fields from the .proto definitions (proto snake_case → Java camelCase). + private static final Map> SCHEMA_ALLOWED_PROPERTIES = Map.of( + "Pipeline", Set.of("id", "name", "stagesList"), + "Stage", Set.of("id", "name", "scriptType", "stageOrder", "command"), + "PipelineBuild", Set.of("id", "pipelineId", "pipelineName", "currentState", "stageBuildsList"), + "StageBuild", Set.of("id", "stageId", "stageName", "stageOrder", "currentState") + ); + + // Proto list accessors use a "List" suffix — rename them to clean API names for the frontend. + private static final Map> PROPERTY_RENAMES = Map.of( + "Pipeline", Map.of("stagesList", "stages"), + "PipelineBuild", Map.of("stageBuildsList", "stageBuilds") + ); + + // Proto enums include a package prefix (PIPELINE_, STAGE_) and an UNRECOGNIZED catch-all. + // Strip the prefix and remove UNRECOGNIZED so the frontend sees SUCCESS not PIPELINE_SUCCESS. + private static final Map> ENUM_PREFIXES = Map.of( + "PipelineBuild", Map.of("currentState", "PIPELINE_"), + "StageBuild", Map.of("currentState", "STAGE_") + ); + + @Override + @SuppressWarnings({"rawtypes", "unchecked"}) + public void customise(OpenAPI openApi) { + if (openApi.getComponents() == null || openApi.getComponents().getSchemas() == null) { + return; + } + + Map schemas = openApi.getComponents().getSchemas(); + + // Step 1: remove all proto internal top-level schemas + schemas.entrySet().removeIf(entry -> !KEEP_SCHEMAS.contains(entry.getKey())); + + // Step 2: strip proto-internal properties, keep only declared business fields + schemas.forEach((name, schema) -> { + Set allowedProps = SCHEMA_ALLOWED_PROPERTIES.get(name); + if (allowedProps != null && schema.getProperties() != null) { + Map props = (Map) schema.getProperties(); + props.entrySet().removeIf(e -> !allowedProps.contains(e.getKey())); + } + }); + + // Step 3: rename proto list accessor names to clean frontend-facing names + schemas.forEach((schemaName, schema) -> { + Map renames = PROPERTY_RENAMES.get(schemaName); + if (renames != null && schema.getProperties() != null) { + Map props = (Map) schema.getProperties(); + renames.forEach((oldName, newName) -> { + Object val = props.remove(oldName); + if (val != null) { + props.put(newName, val); + } + }); + } + }); + + // Step 4: strip proto enum prefixes and remove UNRECOGNIZED catch-all value + schemas.forEach((schemaName, schema) -> { + Map enumPrefixes = ENUM_PREFIXES.get(schemaName); + if (enumPrefixes != null && schema.getProperties() != null) { + Map props = (Map) schema.getProperties(); + enumPrefixes.forEach((fieldName, prefix) -> { + Schema fieldSchema = props.get(fieldName); + if (fieldSchema != null && fieldSchema.getEnum() != null) { + List enumValues = (List) fieldSchema.getEnum(); + enumValues.removeIf(v -> "UNRECOGNIZED".equals(v.toString())); + enumValues.replaceAll(v -> { + String s = v.toString(); + return s.startsWith(prefix) ? s.substring(prefix.length()) : s; + }); + } + }); + } + }); + + // Step 5: sort schemas alphabetically and sort properties within each schema + schemas.forEach((name, schema) -> { + if (schema.getProperties() != null) { + schema.setProperties(new TreeMap<>(schema.getProperties())); + } + }); + openApi.getComponents().setSchemas(new TreeMap<>(schemas)); + } +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/controller/PipelineController.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/controller/PipelineController.java index a7eaddc12..5cdee90cb 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/controller/PipelineController.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/controller/PipelineController.java @@ -19,7 +19,7 @@ import com.autobuild.pipeline.configuration.FeatureFlag; import com.autobuild.pipeline.configuration.FeatureFlagService; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; import com.autobuild.pipeline.definiton.exceptions.DuplicateEntryException; import com.autobuild.pipeline.definiton.exceptions.InvalidIdException; import com.autobuild.pipeline.definiton.service.PipelineService; @@ -58,14 +58,14 @@ public class PipelineController { @Operation(summary = "Get a pipeline") @GetMapping(value = "/{pipelineId}", produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity getPipelineById(@PathVariable String pipelineId) + public ResponseEntity getPipelineById(@PathVariable String pipelineId) throws InvalidIdException, IOException { return ResponseEntity.ok(pipelineService.getPipelineById(pipelineId)); } @Operation(summary = "Get all pipelines") @GetMapping(produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity> getAllPipelines() { + public ResponseEntity> getAllPipelines() { return ResponseEntity.ok(pipelineService.getAllPipelines()); } @@ -74,9 +74,9 @@ public ResponseEntity> getAllPipelines() { responses = @ApiResponse(responseCode = "201") ) @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity createPipeline(@RequestBody @Valid PipelineDTO pipelineRequest) + public ResponseEntity createPipeline(@RequestBody @Valid Pipeline pipelineRequest) throws DuplicateEntryException, IOException, InvalidIdException { - PipelineDTO createdPipeline = pipelineService.createPipeline(pipelineRequest); + Pipeline createdPipeline = pipelineService.createPipeline(pipelineRequest); URI location = URI.create("/api/v1/pipeline/" + createdPipeline.getId()); return ResponseEntity.created(location).body(createdPipeline); } @@ -87,9 +87,9 @@ public ResponseEntity createPipeline(@RequestBody @Valid PipelineDT deprecated = true ) @PatchMapping(value = "/{pipelineId}", produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity modifyPipeline( + public ResponseEntity modifyPipeline( @PathVariable String pipelineId, - @RequestBody PipelineDTO patchRequest) + @RequestBody Pipeline patchRequest) throws InvalidIdException, IOException, DuplicateEntryException { if (!featureFlagService.getBooleanValue(FeatureFlag.ENABLE_EDIT_PIPELINE.getKey())) { return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).build(); @@ -114,9 +114,9 @@ public ResponseEntity deletePipeline(@PathVariable String pipelineId) deprecated = true ) @PutMapping(value = "/{pipelineId}", produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity updatePipeline( + public ResponseEntity updatePipeline( @PathVariable String pipelineId, - @RequestBody @Valid PipelineDTO putRequest) + @RequestBody @Valid Pipeline putRequest) throws InvalidIdException, IOException, DuplicateEntryException { if (!featureFlagService.getBooleanValue(FeatureFlag.ENABLE_EDIT_PIPELINE.getKey())) { return ResponseEntity.status(HttpStatus.NOT_IMPLEMENTED).build(); diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/controller/PipelineGraphQLController.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/controller/PipelineGraphQLController.java index 3d202b214..81f45140c 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/controller/PipelineGraphQLController.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/controller/PipelineGraphQLController.java @@ -8,7 +8,7 @@ import org.springframework.graphql.data.method.annotation.QueryMapping; import org.springframework.stereotype.Controller; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; import com.autobuild.pipeline.definiton.exceptions.InvalidIdException; import com.autobuild.pipeline.definiton.service.PipelineService; @@ -32,7 +32,7 @@ public class PipelineGraphQLController { * @throws IOException if the pipeline script files cannot be read */ @QueryMapping - public PipelineDTO getPipelineById(@Argument String pipelineId) + public Pipeline getPipelineById(@Argument String pipelineId) throws InvalidIdException, IOException { return pipelineService.getPipelineById(pipelineId); } @@ -43,7 +43,7 @@ public PipelineDTO getPipelineById(@Argument String pipelineId) * @return list of all pipelines */ @QueryMapping - public List getAllPipelines() { + public List getAllPipelines() { return pipelineService.getAllPipelines(); } } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/PipelineDTO.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/PipelineDTO.java deleted file mode 100644 index f21bef846..000000000 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/PipelineDTO.java +++ /dev/null @@ -1,34 +0,0 @@ -package com.autobuild.pipeline.definiton.dto; - -import java.util.List; -import java.util.UUID; - -import io.swagger.v3.oas.annotations.media.Schema; -import jakarta.validation.Valid; -import jakarta.validation.constraints.NotEmpty; -import lombok.AllArgsConstructor; -import lombok.Getter; -import lombok.NoArgsConstructor; -import lombok.Setter; - -/** - * Data Transfer Object for Pipeline Entity. - * @author Suvabrata Chowdhury - */ - -@AllArgsConstructor -@NoArgsConstructor -@Getter -@Setter -@Schema(name = "Pipeline") -public class PipelineDTO { - private UUID id; - - @NotEmpty - private String name; - - // @NotNull - @NotEmpty - @Valid - private List stages; -} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/PipelineResponse.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/PipelineResponse.java index 64086811f..b2754d78e 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/PipelineResponse.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/PipelineResponse.java @@ -2,7 +2,7 @@ import java.util.List; -import com.autobuild.pipeline.definiton.entity.Pipeline; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; import com.fasterxml.jackson.annotation.JsonInclude; import lombok.Getter; @@ -19,13 +19,13 @@ public class PipelineResponse { @JsonInclude(JsonInclude.Include.ALWAYS) @Getter - private Pipeline pipeline; + private PipelineEntity pipeline; @Getter @Setter private List errors; - public PipelineResponse(Pipeline pipeline) { + public PipelineResponse(PipelineEntity pipeline) { this.pipeline = pipeline; } } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/StageDTO.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/StageDTO.java deleted file mode 100644 index ba2dfa8cb..000000000 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/StageDTO.java +++ /dev/null @@ -1,42 +0,0 @@ -package com.autobuild.pipeline.definiton.dto; - -import java.util.UUID; - -import com.fasterxml.jackson.annotation.JsonInclude; - -import io.swagger.v3.oas.annotations.media.Schema; -import jakarta.validation.constraints.NotEmpty; -import lombok.AllArgsConstructor; -import lombok.Getter; -import lombok.NoArgsConstructor; -import lombok.Setter; - -/** - * Data Transfer Object for Stage. - * @author Suvabrata Chowdhury - */ - -@JsonInclude(JsonInclude.Include.NON_EMPTY) -@AllArgsConstructor -@NoArgsConstructor -@Getter -@Setter -@Schema(name = "Stage") -public class StageDTO { - private UUID id; - - @NotEmpty - private String name; - - @NotEmpty - private String scriptType; - - @NotEmpty - private String command; - - private int stageOrder; - - public StageDTO(UUID id, String name, String scriptType, String command) { - this(id, name, scriptType, command, 0); - } -} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/mapper/PipelineMapper.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/mapper/PipelineMapper.java index 2a0e82181..302c058da 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/mapper/PipelineMapper.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/mapper/PipelineMapper.java @@ -1,11 +1,15 @@ package com.autobuild.pipeline.definiton.dto.mapper; -import org.modelmapper.ModelMapper; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.entity.Pipeline; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.definiton.entity.StageEntity; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; +import com.autobuild.pipeline.definiton.gen.dto.Stage; + +import java.util.List; +import java.util.UUID; /** * Used to map Pipeline Entity to Pipeline DTO. @@ -13,28 +17,46 @@ */ @Component -public class PipelineMapper implements Mapper{ - @Autowired - private ModelMapper mapper; +public class PipelineMapper implements Mapper{ - // @Autowired - // private StageMapper stageMapper; + @Autowired + private StageMapper stageMapper; @Override - public Pipeline dtoToEntity(PipelineDTO pipelineDTO) { - if (null == pipelineDTO) { + public PipelineEntity dtoToEntity(Pipeline pipelineProto) { + if (null == pipelineProto) { throw new IllegalArgumentException("Given null object can not be mapped"); } - return this.mapper.map(pipelineDTO, Pipeline.class); + List stages = pipelineProto.getStagesList() + .stream() + .map(stageMapper::dtoToEntity) + .toList(); + + PipelineEntity pipeline = new PipelineEntity(); + if (!pipelineProto.getId().isBlank()) { + pipeline.setId(UUID.fromString(pipelineProto.getId())); + } + pipeline.setName(pipelineProto.getName()); + pipeline.setStages(stages); + return pipeline; } @Override - public PipelineDTO entityToDto(Pipeline pipeline) { + public Pipeline entityToDto(PipelineEntity pipeline) { if (null == pipeline) { throw new IllegalArgumentException("Given null object can not be mapped"); } - return this.mapper.map(pipeline, PipelineDTO.class); + List stagesProto = pipeline.getStages() + .stream() + .map(stageMapper::entityToDto) + .toList(); + + return Pipeline.newBuilder() + .setId(pipeline.getId().toString()) + .setName(pipeline.getName()) + .addAllStages(stagesProto) + .build(); } } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/mapper/StageMapper.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/mapper/StageMapper.java index 7523eae57..2676c86e6 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/mapper/StageMapper.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/dto/mapper/StageMapper.java @@ -1,11 +1,11 @@ package com.autobuild.pipeline.definiton.dto.mapper; -import org.modelmapper.ModelMapper; -import org.springframework.beans.factory.annotation.Autowired; +import java.util.UUID; + import org.springframework.stereotype.Component; -import com.autobuild.pipeline.definiton.dto.StageDTO; -import com.autobuild.pipeline.definiton.entity.Stage; +import com.autobuild.pipeline.definiton.entity.StageEntity; +import com.autobuild.pipeline.definiton.gen.dto.Stage; /** * Used to map Stage Entity to Stage DTO. @@ -13,25 +13,37 @@ */ @Component -public class StageMapper implements Mapper{ - @Autowired - private ModelMapper mapper; +public class StageMapper implements Mapper< + Stage, + StageEntity> { @Override - public Stage dtoToEntity(StageDTO stageDto) { - if (null == stageDto) { + public StageEntity dtoToEntity(Stage dto) { + if (null == dto) { throw new IllegalArgumentException("Given null object can not be mapped"); } - return this.mapper.map(stageDto, Stage.class); + StageEntity entity = new StageEntity(); + if (!dto.getId().isBlank()) { + entity.setId(UUID.fromString(dto.getId())); + } + entity.setName(dto.getName()); + entity.setScriptType(dto.getScriptType()); + entity.setStageOrder(dto.getStageOrder()); + return entity; } @Override - public StageDTO entityToDto(Stage stage) { - if (null == stage) { + public Stage entityToDto(StageEntity entity) { + if (entity == null) { throw new IllegalArgumentException("Given null object can not be mapped"); } - return this.mapper.map(stage, StageDTO.class); + return Stage.newBuilder() + .setId(entity.getId().toString()) + .setName(entity.getName()) + .setScriptType(entity.getScriptType()) + .setStageOrder(entity.getStageOrder()) + .build(); } } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/Pipeline.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/PipelineEntity.java similarity index 88% rename from pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/Pipeline.java rename to pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/PipelineEntity.java index 46cd87ffa..3ad66a3b8 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/Pipeline.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/PipelineEntity.java @@ -32,11 +32,11 @@ @Getter @Setter @Entity -@Table(uniqueConstraints = { +@Table(name = "pipeline", uniqueConstraints = { @UniqueConstraint(name = "UK_PIPELINE_NAME", columnNames = { "name" }) }) @Check(name = "CHK_PIPELINE_NAME", constraints = "name != '' ") -public class Pipeline { +public class PipelineEntity { @Id @Column(name = "id", nullable = false) private UUID id; @@ -53,5 +53,5 @@ public class Pipeline { inverseJoinColumns = @JoinColumn(name = "stage_id") ) @OrderBy("stageOrder ASC") - private List stages; + private List stages; // TODO: need to take an abstract implementation of stage } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/Stage.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/StageEntity.java similarity index 88% rename from pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/Stage.java rename to pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/StageEntity.java index 81ddd17b9..a2b51f5e2 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/Stage.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/entity/StageEntity.java @@ -7,6 +7,7 @@ import jakarta.persistence.Column; import jakarta.persistence.Entity; +import jakarta.persistence.Table; import jakarta.persistence.Id; import jakarta.validation.constraints.NotEmpty; import lombok.AllArgsConstructor; @@ -25,12 +26,13 @@ @Getter @Setter @Entity +@Table(name = "stage") @Checks({ @Check(name = "CHK_STAGE_NAME", constraints = "name != '' "), @Check(name = "CHK_STAGE_SCRIPT_TYPE", constraints = "script_type != '' "), @Check(name = "CHK_PATH_COMMAND", constraints = "path != '' ") }) -public class Stage { +public class StageEntity { @Id @Column(name = "id") private UUID id; @@ -50,7 +52,7 @@ public class Stage { @Column(name = "stage_order", nullable = false) private int stageOrder; - public Stage(UUID id, String name, String scriptType, String path) { + public StageEntity(UUID id, String name, String scriptType, String path) { this(id, name, scriptType, path, 0); } } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/repository/PipelineRepository.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/repository/PipelineRepository.java index 6602c18b1..170615a51 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/repository/PipelineRepository.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/repository/PipelineRepository.java @@ -5,7 +5,7 @@ import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; -import com.autobuild.pipeline.definiton.entity.Pipeline; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; /** * Repository Layer for all pipeline related entities. @@ -13,7 +13,7 @@ */ @Repository -public interface PipelineRepository extends JpaRepository { +public interface PipelineRepository extends JpaRepository { boolean existsByName(String name); diff --git a/pipeline/src/main/java/com/autobuild/pipeline/definiton/service/PipelineService.java b/pipeline/src/main/java/com/autobuild/pipeline/definiton/service/PipelineService.java index 04b5df0ea..32442fb75 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/definiton/service/PipelineService.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/definiton/service/PipelineService.java @@ -12,12 +12,12 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.dto.StageDTO; import com.autobuild.pipeline.definiton.dto.mapper.PipelineMapper; import com.autobuild.pipeline.definiton.dto.mapper.StageMapper; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.definiton.entity.Stage; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.definiton.entity.StageEntity; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; +import com.autobuild.pipeline.definiton.gen.dto.Stage; import com.autobuild.pipeline.definiton.exceptions.DuplicateEntryException; import com.autobuild.pipeline.definiton.exceptions.InvalidIdException; import com.autobuild.pipeline.definiton.repository.PipelineRepository; @@ -48,53 +48,66 @@ public class PipelineService { @Autowired private StageMapper stageMapper; - public PipelineDTO getPipelineById(final String pipelineId) + public Pipeline getPipelineById(final String pipelineId) throws InvalidIdException, IOException { validatePipelineId(pipelineId); try { - Pipeline pipeline = getPipelineFromId(pipelineId); + PipelineEntity pipeline = getPipelineFromId(pipelineId); Map stageContents = fileService.readScriptFiles(pipeline); - PipelineDTO pipelineDTO = mapper.entityToDto(pipeline); - pipelineDTO.getStages() - .forEach(stage -> stage.setCommand(stageContents.get(stage.getId()))); + Pipeline pipelineDTO = mapper.entityToDto(pipeline); + Pipeline pipelineWithCommands = pipelineDTO.toBuilder() + .clearStages() + .addAllStages( + pipelineDTO.getStagesList().stream() + .map(s -> s.toBuilder() + .setCommand(stageContents.getOrDefault(UUID.fromString(s.getId()), "")) + .build()) + .toList() + ) + .build(); log.info("Pipeline with id {} successfully obtained", pipelineDTO.getId()); - return pipelineDTO; + return pipelineWithCommands; } catch (IllegalArgumentException e) { throw new InvalidIdException("Pipeline Id is invalid"); } } - public List getAllPipelines() { - List pipelines = repository.findAll(); + public List getAllPipelines() { + List pipelines = repository.findAll(); log.info("Fetched all pipelines, count: {}", pipelines.size()); return pipelines.stream() .map(pipeline -> { - PipelineDTO dto = mapper.entityToDto(pipeline); // converting each fetched pipeline into PiplineDTO + Pipeline dto = mapper.entityToDto(pipeline); // converting each fetched pipeline into PiplineDTO return dto; }) .toList(); } - public PipelineDTO createPipeline(final PipelineDTO pipelineDto) + public Pipeline createPipeline(final Pipeline pipelineDto) throws IOException, DuplicateEntryException, InvalidIdException { if (repository.existsByName(pipelineDto.getName())) { throw new DuplicateEntryException( "Pipeline with name '" + pipelineDto.getName() + "' already exists"); } - for (StageDTO stage : pipelineDto.getStages()) { + for (Stage stage : pipelineDto.getStagesList()) { validateScriptType(stage.getScriptType()); } - validateStageOrders(pipelineDto.getStages()); - pipelineDto.setId(UUID.randomUUID()); - pipelineDto.getStages().forEach(stage -> stage.setId(UUID.randomUUID())); + validateStageOrders(pipelineDto.getStagesList()); - Pipeline pipeline = mapper.dtoToEntity(pipelineDto); - Map scriptLocations = createScriptFiles(pipelineDto); + Pipeline pipelineWithIds = pipelineDto.toBuilder() + .setId(UUID.randomUUID().toString()) + .clearStages() + .addAllStages(pipelineDto.getStagesList().stream() + .map(s -> s.toBuilder().setId(UUID.randomUUID().toString()).build()).toList()) + .build(); + + PipelineEntity pipeline = mapper.dtoToEntity(pipelineWithIds); + Map scriptLocations = createScriptFiles(pipelineWithIds); pipeline.getStages() .forEach(stage -> stage.setPath(scriptLocations.get(stage.getId()))); - Pipeline createdPipeline = repository.save(pipeline); + PipelineEntity createdPipeline = repository.save(pipeline); log.info("Pipeline with id {} successfully created", createdPipeline.getId()); return mapper.entityToDto(createdPipeline); } @@ -103,7 +116,7 @@ public void deletePipelineById(String pipelineId) throws IOException, InvalidIdException { validatePipelineId(pipelineId); try { - Pipeline pipeline = getPipelineFromId(pipelineId); + PipelineEntity pipeline = getPipelineFromId(pipelineId); deletePipeline(pipeline); log.info("Pipeline with id {} successfully deleted", pipelineId); } catch (IllegalArgumentException e) { @@ -111,18 +124,18 @@ public void deletePipelineById(String pipelineId) } } - public PipelineDTO modifyPipeline(String pipelineId, PipelineDTO patchRequest) + public Pipeline modifyPipeline(String pipelineId, Pipeline patchRequest) throws InvalidIdException, IOException, DuplicateEntryException { validatePipelineId(pipelineId); validateModifyRequest(patchRequest); - Pipeline pipeline = getPipelineFromId(pipelineId); + PipelineEntity pipeline = getPipelineFromId(pipelineId); boolean nameChange = patchRequest.getName() != null && !patchRequest.getName().isBlank(); - boolean stagesChange = patchRequest.getStages() != null - && !patchRequest.getStages().isEmpty(); + boolean stagesChange = patchRequest.getStagesList() != null + && !patchRequest.getStagesList().isEmpty(); if (nameChange) { if (!patchRequest.getName().equals(pipeline.getName()) @@ -134,16 +147,25 @@ public PipelineDTO modifyPipeline(String pipelineId, PipelineDTO patchRequest) } if (stagesChange) { - processStageChanges(pipeline, patchRequest.getStages()); + processStageChanges(pipeline, patchRequest.getStagesList()); } repository.save(pipeline); Map finalScripts = fileService.readScriptFiles(pipeline); - PipelineDTO response = mapper.entityToDto(pipeline); - response.getStages().forEach(s -> s.setCommand(finalScripts.get(s.getId()))); + Pipeline response = mapper.entityToDto(pipeline); + Pipeline pipelineWithCommands = response.toBuilder() + .clearStages() + .addAllStages( + response.getStagesList().stream() + .map(s -> s.toBuilder() + .setCommand(finalScripts.getOrDefault(UUID.fromString(s.getId()), "")) + .build()) + .toList() + ) + .build(); log.info("Pipeline with id {} successfully modified", pipelineId); - return response; + return pipelineWithCommands; } private void validatePipelineId(String pipelineId) throws InvalidIdException { @@ -152,9 +174,9 @@ private void validatePipelineId(String pipelineId) throws InvalidIdException { } } - private void validateModifyRequest(PipelineDTO request) throws InvalidIdException { + private void validateModifyRequest(Pipeline request) throws InvalidIdException { boolean hasName = request.getName() != null && !request.getName().isBlank(); - boolean hasStages = request.getStages() != null && !request.getStages().isEmpty(); + boolean hasStages = request.getStagesList() != null && !request.getStagesList().isEmpty(); if (!hasName && !hasStages) { throw new InvalidIdException("At least name or stages must be provided"); @@ -172,16 +194,16 @@ private void validateScriptType(String scriptType) throws InvalidIdException { } } - private void processStageChanges(Pipeline pipeline, List stageRequests) + private void processStageChanges(PipelineEntity pipeline, List stageRequests) throws InvalidIdException, IOException, DuplicateEntryException { validateStageRequests(stageRequests); - for (StageDTO req : stageRequests) { + for (Stage req : stageRequests) { if (isCreateOperation(req)) { createStage(pipeline, req); } else if (isDeleteOperation(req)) { - deleteStage(pipeline, req.getId()); + deleteStage(pipeline, UUID.fromString(req.getId())); } else { updateStage(pipeline, req); } @@ -190,22 +212,22 @@ private void processStageChanges(Pipeline pipeline, List stageRequests reorderStages(pipeline, stageRequests); } - private void reorderStages(Pipeline pipeline, List stageRequests) { - List current = pipeline.getStages(); + private void reorderStages(PipelineEntity pipeline, List stageRequests) { + List current = pipeline.getStages(); List requestedIds = stageRequests.stream() - .filter(req -> req.getId() != null && !isDeleteOperation(req)) - .map(StageDTO::getId) + .filter(req -> !req.getId().isBlank() && !isDeleteOperation(req)) + .map(req -> UUID.fromString(req.getId())) .toList(); - List reordered = new ArrayList<>(); + List reordered = new ArrayList<>(); for (UUID id : requestedIds) { current.stream() .filter(s -> s.getId().equals(id)) .findFirst() .ifPresent(reordered::add); } - for (Stage s : current) { + for (StageEntity s : current) { if (!reordered.contains(s)) { reordered.add(s); } @@ -219,65 +241,54 @@ private void reorderStages(Pipeline pipeline, List stageRequests) { current.addAll(reordered); } - private boolean isCreateOperation(StageDTO req) { - return req.getId() == null; + private boolean isCreateOperation(Stage req) { + return req.getId().isBlank(); } - private boolean isDeleteOperation(StageDTO req) { - return req.getId() != null - && req.getName() == null - && req.getScriptType() == null - && req.getCommand() == null; + private boolean isDeleteOperation(Stage req) { + return !req.getId().isBlank() + && req.getName().isBlank() + && req.getScriptType().isBlank() + && req.getCommand().isBlank(); } - private void createStage(Pipeline pipeline, StageDTO req) + private void createStage(PipelineEntity pipeline, Stage req) throws IOException, InvalidIdException { validateScriptType(req.getScriptType()); - req.setId(UUID.randomUUID()); - req.setStageOrder(pipeline.getStages().size()); - Stage entity = stageMapper.dtoToEntity(req); - String path = fileService.createStageScriptFile(pipeline, req); + Stage reqWithId = req.toBuilder() + .setId(UUID.randomUUID().toString()) + .setStageOrder(pipeline.getStages().size()) + .build(); + StageEntity entity = stageMapper.dtoToEntity(reqWithId); + String path = fileService.createStageScriptFile(pipeline, reqWithId); entity.setPath(path); pipeline.getStages().add(entity); } - private void updateStage(Pipeline pipeline, StageDTO req) + private void updateStage(PipelineEntity pipeline, Stage req) throws InvalidIdException, IOException { - Stage toUpdate = findStage(pipeline, req.getId()); + StageEntity toUpdate = findStage(pipeline, UUID.fromString(req.getId())); - if (req.getName() != null && !req.getName().isBlank()) { + if (!req.getName().isBlank()) { toUpdate.setName(req.getName()); } - if (req.getScriptType() != null) { + if (!req.getScriptType().isBlank()) { throw new InvalidIdException("Script type updates are not allowed"); } - if (req.getCommand() != null && !req.getCommand().isBlank()) { + if (!req.getCommand().isBlank()) { fileService.updateStageScriptFile(toUpdate, req.getCommand()); } } - private void validateStageOrders(List stages) throws DuplicateEntryException, InvalidIdException { - Set seen = new HashSet<>(); - for (StageDTO stage : stages) { - if (stage.getStageOrder() < 0) { - throw new InvalidIdException("stageOrder must be a non-negative integer: " + stage.getStageOrder()); - } - if (!seen.add(stage.getStageOrder())) { - throw new DuplicateEntryException( - "Duplicate stageOrder value: " + stage.getStageOrder()); - } - } - } - - private void validateStageRequests(List requests) + private void validateStageRequests(List requests) throws InvalidIdException, DuplicateEntryException { Set ids = new HashSet<>(); - for (StageDTO req : requests) { + for (Stage req : requests) { if (isCreateOperation(req)) { validateScriptType(req.getScriptType()); continue; @@ -287,32 +298,47 @@ private void validateStageRequests(List requests) continue; } - if (req.getScriptType() != null) { + if (!req.getScriptType().isBlank()) { throw new InvalidIdException("Script type updates are not allowed"); } - if (!ids.add(req.getId())) { + if (!ids.add(UUID.fromString(req.getId()))) { throw new DuplicateEntryException("Duplicate stage ID in request: " + req.getId()); } } } - private void deleteStage(Pipeline pipeline, UUID stageId) + private void validateStageOrders(List stages) + throws DuplicateEntryException, InvalidIdException { + Set seen = new HashSet<>(); + for (Stage stage : stages) { + if (stage.getStageOrder() < 0) { + throw new InvalidIdException( + "stageOrder must be a non-negative integer: " + stage.getStageOrder()); + } + if (!seen.add(stage.getStageOrder())) { + throw new DuplicateEntryException( + "Duplicate stageOrder value: " + stage.getStageOrder()); + } + } + } + + private void deleteStage(PipelineEntity pipeline, UUID stageId) throws InvalidIdException, IOException { - Stage toDelete = findStage(pipeline, stageId); + StageEntity toDelete = findStage(pipeline, stageId); fileService.removeStageScriptFile(toDelete); pipeline.getStages().removeIf(s -> s.getId().equals(stageId)); } - private Stage findStage(Pipeline pipeline, UUID id) throws InvalidIdException { + private StageEntity findStage(PipelineEntity pipeline, UUID id) throws InvalidIdException { return pipeline.getStages().stream() .filter(s -> s.getId().equals(id)) .findFirst() .orElseThrow(() -> new InvalidIdException("Stage not found: " + id)); } - private Pipeline getPipelineFromId(final String pipelineId) { - Optional optionalPipeline = repository.findById(UUID.fromString(pipelineId)); + private PipelineEntity getPipelineFromId(final String pipelineId) { + Optional optionalPipeline = repository.findById(UUID.fromString(pipelineId)); if (!optionalPipeline.isPresent()) { throw new EntityNotFoundException( "Pipeline with id " + pipelineId + " not found"); @@ -320,7 +346,7 @@ private Pipeline getPipelineFromId(final String pipelineId) { return optionalPipeline.get(); } - private Map createScriptFiles(PipelineDTO pipeline) throws IOException { + private Map createScriptFiles(Pipeline pipeline) throws IOException { try { return fileService.createScriptFiles(pipeline); } catch (IOException e) { @@ -329,11 +355,11 @@ private Map createScriptFiles(PipelineDTO pipeline) throws IOExcep } } - public PipelineDTO replacePipeline(String pipelineId, PipelineDTO putRequest) + public Pipeline replacePipeline(String pipelineId, Pipeline putRequest) throws InvalidIdException, IOException, DuplicateEntryException { validatePipelineId(pipelineId); - Pipeline pipeline = getPipelineFromId(pipelineId); + PipelineEntity pipeline = getPipelineFromId(pipelineId); // Check for duplicate name if (!putRequest.getName().equals(pipeline.getName()) @@ -346,17 +372,20 @@ public PipelineDTO replacePipeline(String pipelineId, PipelineDTO putRequest) pipeline.setName(putRequest.getName()); // Delete all existing stages and their files - for (Stage existingStage : pipeline.getStages()) { + for (StageEntity existingStage : pipeline.getStages()) { fileService.removeStageScriptFile(existingStage); } pipeline.getStages().clear(); // Create new stages from request - for (StageDTO stageDTO : putRequest.getStages()) { + for (Stage stageDTO : putRequest.getStagesList()) { validateScriptType(stageDTO.getScriptType()); - stageDTO.setId(UUID.randomUUID()); - String path = fileService.createStageScriptFile(pipeline, stageDTO); - Stage newStage = stageMapper.dtoToEntity(stageDTO); + Stage stageWithId = stageDTO.toBuilder() + .setId(UUID.randomUUID().toString()) + .build(); + + String path = fileService.createStageScriptFile(pipeline, stageWithId); + StageEntity newStage = stageMapper.dtoToEntity(stageWithId); newStage.setPath(path); pipeline.getStages().add(newStage); } @@ -364,13 +393,22 @@ public PipelineDTO replacePipeline(String pipelineId, PipelineDTO putRequest) repository.save(pipeline); Map finalScripts = fileService.readScriptFiles(pipeline); - PipelineDTO response = mapper.entityToDto(pipeline); - response.getStages().forEach(s -> s.setCommand(finalScripts.get(s.getId()))); + Pipeline response = mapper.entityToDto(pipeline); + Pipeline responseWithCommands = response.toBuilder() + .clearStages() + .addAllStages( + response.getStagesList().stream() + .map(s -> s.toBuilder() + .setCommand(finalScripts.getOrDefault(UUID.fromString(s.getId()), "")) + .build()) + .toList() + ) + .build(); log.info("Pipeline with id {} successfully replaced", pipelineId); - return response; + return responseWithCommands; } - private void deletePipeline(Pipeline pipeline) throws IOException { + private void deletePipeline(PipelineEntity pipeline) throws IOException { fileService.removeScriptFiles(mapper.entityToDto(pipeline)); repository.delete(pipeline); } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/controller/PipelineBuildController.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/controller/PipelineBuildController.java index 696c883f5..fc95763af 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/controller/PipelineBuildController.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/controller/PipelineBuildController.java @@ -13,9 +13,10 @@ 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.service.PipelineBuildService; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; + import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.enums.SecuritySchemeType; import io.swagger.v3.oas.annotations.security.SecurityRequirement; @@ -48,13 +49,13 @@ public class PipelineBuildController { @Operation(summary = "Get a pipeline build") @GetMapping(value = "/{pipelineBuildId}", produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity getPipelineBuild(@PathVariable UUID pipelineBuildId) { + public ResponseEntity getPipelineBuild(@PathVariable UUID pipelineBuildId) { return ResponseEntity.ok(service.getPipelineBuild(pipelineBuildId)); } @Operation(summary = "Get all pipeline builds") @GetMapping(produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity> getAllBuilds() { + public ResponseEntity> getAllBuilds() { return ResponseEntity.ok(service.getAllBuilds()); } 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 a02140f45..35fd86866 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 @@ -10,10 +10,11 @@ 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; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; + import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.enums.SecuritySchemeType; import io.swagger.v3.oas.annotations.responses.ApiResponse; @@ -45,9 +46,9 @@ public class PipelineExecutorController { @Operation(summary = "Execute a pipeline", responses = @ApiResponse(responseCode = "203")) @PostMapping(value = "/pipeline", produces = MediaType.APPLICATION_JSON_VALUE) - public ResponseEntity executePipeline(@RequestBody @Valid PipelineExecuteRequest request) + public ResponseEntity executePipeline(@RequestBody @Valid PipelineExecuteRequest request) throws IOException { - PipelineBuildDTO build = service.executePipeline(request); + PipelineBuild build = service.executePipeline(request); return ResponseEntity.accepted().body(build); } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/PipelineBuildDTO.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/PipelineBuildDTO.java deleted file mode 100644 index daebe4f97..000000000 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/PipelineBuildDTO.java +++ /dev/null @@ -1,39 +0,0 @@ -package com.autobuild.pipeline.executor.dto; - -import java.time.Instant; -import java.util.List; -import java.util.UUID; - -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; - -import io.swagger.v3.oas.annotations.media.Schema; -import lombok.AllArgsConstructor; -import lombok.Getter; -import lombok.NoArgsConstructor; -import lombok.Setter; - -/** - * Data Transfer Object for PipelineBuild. - * - * @author Suvabrata Chowdhury - */ - -@NoArgsConstructor -@AllArgsConstructor -@Getter -@Setter -@Schema(name = "PipelineBuild") -public class PipelineBuildDTO { - private UUID id; - // private int buildNo; - - private UUID pipelineId; - - private String pipelineName; - - private PipelineExecutionState currentState; - - private Instant startedAt; - - private List stageBuilds; -} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/StageBuildDTO.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/StageBuildDTO.java deleted file mode 100644 index c66682752..000000000 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/StageBuildDTO.java +++ /dev/null @@ -1,38 +0,0 @@ -package com.autobuild.pipeline.executor.dto; - -import java.util.UUID; - -import com.autobuild.pipeline.executor.execution.state.StageExecutionState; - -import io.swagger.v3.oas.annotations.media.Schema; -import lombok.AllArgsConstructor; -import lombok.Getter; -import lombok.NoArgsConstructor; -import lombok.Setter; - -/** - * Data Transfer Object for StageBuild. - * - * @author Suvabrata Chowdhury - */ - -@NoArgsConstructor -@AllArgsConstructor -@Getter -@Setter -@Schema(name = "StageBuild") -public class StageBuildDTO { - private UUID id; - - private UUID stageId; - - private String stageName; - - private int stageOrder; - - private StageExecutionState currentState; - - public StageBuildDTO(UUID id, UUID stageId, String stageName, StageExecutionState currentState) { - this(id, stageId, stageName, 0, currentState); - } -} \ No newline at end of file diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/mapper/PipelineBuildMapper.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/mapper/PipelineBuildMapper.java index ef1274685..daba7c485 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/mapper/PipelineBuildMapper.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/mapper/PipelineBuildMapper.java @@ -1,36 +1,79 @@ package com.autobuild.pipeline.executor.dto.mapper; -import org.modelmapper.ModelMapper; +import java.time.Instant; +import java.util.List; + import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import com.autobuild.pipeline.definiton.dto.mapper.Mapper; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; +import com.autobuild.pipeline.executor.gen.dto.PipelineExecutionState; +import com.autobuild.pipeline.executor.gen.dto.StageBuild; +import com.google.protobuf.Timestamp; /** * Used to map PipelineBuild to PipelineBuildDTO and vice versa. - * + * * @author Suvabrata Chowdhury */ - @Component -public class PipelineBuildMapper implements Mapper { +public class PipelineBuildMapper implements Mapper< + PipelineBuild, PipelineBuildEntity> { @Autowired - private ModelMapper mapper; + private StageBuildMapper stageBuildMapper; @Override - public PipelineBuild dtoToEntity(PipelineBuildDTO pipelineBuildDTO) { + public PipelineBuildEntity dtoToEntity( + PipelineBuild dto) { throw new UnsupportedOperationException("DTO is not persistable"); } @Override - public PipelineBuildDTO entityToDto(PipelineBuild pipelineBuild) { - if (null == pipelineBuild) { + public PipelineBuild entityToDto( + PipelineBuildEntity entity) { + if (entity == null) { throw new IllegalArgumentException("Given null object can not be mapped"); } - return this.mapper.map(pipelineBuild, PipelineBuildDTO.class); + List protoStageBuilds = entity.getStageBuilds() + .stream() + .map(stageBuildMapper::entityToDto) + .toList(); + + return PipelineBuild.newBuilder() + .setId(entity.getId().toString()) + .setPipelineId(entity.getPipeline().getId().toString()) + .setPipelineName(entity.getPipeline().getName()) + .setCurrentState(toProtoState(entity.getCurrentState())) + .addAllStageBuilds(protoStageBuilds) + .setStartedAt(toTimestamp(entity.getStartedAt())) + .build(); + } + + private PipelineExecutionState toProtoState( + PipelineEntityExecutionState state) { + switch (state) { + case WAITING: + return PipelineExecutionState.PIPELINE_WAITING; + case RUNNING: + return PipelineExecutionState.PIPELINE_RUNNING; + case SUCCESS: + return PipelineExecutionState.PIPELINE_SUCCESS; + case FAILED: + return PipelineExecutionState.PIPELINE_FAILED; + default: + throw new IllegalArgumentException("Unknown state: " + state); + } + } + + private Timestamp toTimestamp(Instant instant) { + return Timestamp.newBuilder() + .setSeconds(instant.getEpochSecond()) + .setNanos(instant.getNano()) + .build(); } } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/mapper/StageBuildMapper.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/mapper/StageBuildMapper.java index edba0fe04..cd5fd6282 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/mapper/StageBuildMapper.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/dto/mapper/StageBuildMapper.java @@ -1,37 +1,59 @@ package com.autobuild.pipeline.executor.dto.mapper; -import org.modelmapper.ModelMapper; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import com.autobuild.pipeline.definiton.dto.mapper.Mapper; -import com.autobuild.pipeline.executor.dto.StageBuildDTO; -import com.autobuild.pipeline.executor.entity.StageBuild; +import com.autobuild.pipeline.executor.execution.state.StageEntityExecutionState; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; +import com.autobuild.pipeline.executor.gen.dto.StageBuild; +import com.autobuild.pipeline.executor.gen.dto.StageExecutionState; /** * Used to map StageBuild to StageBuildDTO and vice versa. - * + * * @author Suvabrata Chowdhury */ - @Component -public class StageBuildMapper implements Mapper{ - - @Autowired - private ModelMapper modelMapper; +public class StageBuildMapper implements Mapper< + StageBuild, StageBuildEntity> { @Override - public StageBuild dtoToEntity(StageBuildDTO stageBuildDTO) { + public StageBuildEntity dtoToEntity( + StageBuild dto) { throw new UnsupportedOperationException("DTO is not persistable"); } @Override - public StageBuildDTO entityToDto(StageBuild stageBuild) { - if (null == stageBuild) { + public StageBuild entityToDto( + StageBuildEntity entity) { + if (entity == null) { throw new IllegalArgumentException("Given null object can not be mapped"); } - return this.modelMapper.map(stageBuild, StageBuildDTO.class); + return StageBuild.newBuilder() + .setId(entity.getId().toString()) + .setStageId(entity.getStage().getId().toString()) + .setStageName(entity.getStage().getName()) + .setStageOrder(entity.getStageOrder()) + .setCurrentState(toProtoState(entity.getCurrentState())) + .build(); + } + + private StageExecutionState toProtoState( + StageEntityExecutionState state) { + switch (state) { + case WAITING: + return StageExecutionState.STAGE_WAITING; + case RUNNING: + return StageExecutionState.STAGE_RUNNING; + case SUCCESS: + return StageExecutionState.STAGE_SUCCESS; + case FAILED: + return StageExecutionState.STAGE_FAILED; + case STOPPED: + return StageExecutionState.STAGE_STOPPED; + default: + throw new IllegalArgumentException("Unknown state: " + state); + } } - } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/entity/PipelineBuild.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/entity/PipelineBuildEntity.java similarity index 70% rename from pipeline/src/main/java/com/autobuild/pipeline/executor/entity/PipelineBuild.java rename to pipeline/src/main/java/com/autobuild/pipeline/executor/entity/PipelineBuildEntity.java index 9506cc75d..d00a5946e 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/entity/PipelineBuild.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/entity/PipelineBuildEntity.java @@ -4,12 +4,13 @@ import java.util.List; import java.util.UUID; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; import jakarta.persistence.CascadeType; import jakarta.persistence.Column; import jakarta.persistence.Entity; +import jakarta.persistence.Table; import jakarta.persistence.EnumType; import jakarta.persistence.Enumerated; import jakarta.persistence.Id; @@ -27,42 +28,43 @@ /** * PipelineBuild entity to hold data/metadata about execution in table. - * + * * @author Suvabrata Chowdhury */ - //TODO: Add timestamps @NoArgsConstructor @AllArgsConstructor @Getter @Setter @Entity -public class PipelineBuild { +@Table(name = "pipeline_build") +public class PipelineBuildEntity { + @Id private UUID id; @ManyToOne @JoinColumn(name = "pipeline_id", referencedColumnName = "id", nullable = false) - private Pipeline pipeline; + private PipelineEntity pipeline; @NotEmpty @OneToMany(cascade = CascadeType.ALL) @JoinTable( - name = "pipeline_stage_builds", - joinColumns = @JoinColumn(name = "pipeline_build_id"), - inverseJoinColumns = @JoinColumn(name = "stage_build_id") + name = "pipeline_stage_builds", + joinColumns = @JoinColumn(name = "pipeline_build_id"), + inverseJoinColumns = @JoinColumn(name = "stage_build_id") ) @OrderBy("stageOrder ASC") - private List stageBuilds; + private List stageBuilds; @Enumerated(EnumType.STRING) @Column(name = "pipeline_build_current_state", nullable = false) - private PipelineExecutionState currentState; + private PipelineEntityExecutionState currentState; @Column(name = "start_at", nullable = false) private Instant startedAt; - - public PipelineBuild(Pipeline pipeline, List stageBuilds) { + + public PipelineBuildEntity(PipelineEntity pipeline, List stageBuilds) { this.pipeline = pipeline; this.stageBuilds = stageBuilds; } @@ -70,7 +72,7 @@ public PipelineBuild(Pipeline pipeline, List stageBuilds) { @PrePersist public void setDefaultState() { if (null == this.currentState) { - this.currentState = PipelineExecutionState.WAITING; + this.currentState = PipelineEntityExecutionState.WAITING; } this.startedAt = Instant.now(); } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/entity/StageBuild.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/entity/StageBuildEntity.java similarity index 63% rename from pipeline/src/main/java/com/autobuild/pipeline/executor/entity/StageBuild.java rename to pipeline/src/main/java/com/autobuild/pipeline/executor/entity/StageBuildEntity.java index 4d436bd85..ec5c6cb5c 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/entity/StageBuild.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/entity/StageBuildEntity.java @@ -2,11 +2,12 @@ import java.util.UUID; -import com.autobuild.pipeline.definiton.entity.Stage; -import com.autobuild.pipeline.executor.execution.state.StageExecutionState; +import com.autobuild.pipeline.definiton.entity.StageEntity; +import com.autobuild.pipeline.executor.execution.state.StageEntityExecutionState; import jakarta.persistence.Column; import jakarta.persistence.Entity; +import jakarta.persistence.Table; import jakarta.persistence.EnumType; import jakarta.persistence.Enumerated; import jakarta.persistence.Id; @@ -20,27 +21,28 @@ /** * StageBuild entity for holding stage execution metadata/data in table. - * + * * @author Suvabrata Chowdhury */ - //TODO: Add timestamps @NoArgsConstructor @AllArgsConstructor @Getter @Setter @Entity -public class StageBuild { +@Table(name = "stage_build") +public class StageBuildEntity { + @Id private UUID id; @ManyToOne @JoinColumn(name = "stage_id", referencedColumnName = "id", nullable = false) - private Stage stage; + private StageEntity stage; @Enumerated(EnumType.STRING) @Column(name = "stage_build_current_state", nullable = false) - private StageExecutionState currentState; + private StageEntityExecutionState currentState; @Column(name = "stage_order", nullable = false) private int stageOrder; @@ -48,19 +50,24 @@ public class StageBuild { @Column(name = "log_path", nullable = false) private String logPath; - public StageBuild(Stage stage) { + public StageBuildEntity(UUID id, StageEntity stage, StageEntityExecutionState currentState, String logPath) { + this.id = id; this.stage = stage; + this.currentState = currentState; this.stageOrder = stage.getStageOrder(); + this.logPath = logPath; } - public StageBuild(UUID id, Stage stage, StageExecutionState currentState, String logPath) { - this(id, stage, currentState, stage.getStageOrder(), logPath); + public StageBuildEntity(StageEntity stage) { + this.stage = stage; + this.stageOrder = stage.getStageOrder(); } + @PrePersist public void setDefaultState() { if (null == this.currentState) { - this.currentState = StageExecutionState.WAITING; + this.currentState = StageEntityExecutionState.WAITING; } } -} \ No newline at end of file +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/PipelineExecutionObservable.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/PipelineExecutionObservable.java index e1e8d3155..fa0e948b4 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/PipelineExecutionObservable.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/PipelineExecutionObservable.java @@ -5,7 +5,7 @@ import org.springframework.stereotype.Component; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; /** * Pipeline ongoing build (or execution) observable interface. @@ -15,15 +15,15 @@ @Component public interface PipelineExecutionObservable { - public void attachExecutionForObservation(PipelineBuild pipelineBuild); - public void removeExecutionForObservation(PipelineBuild pipelineBuild); + public void attachExecutionForObservation(PipelineBuildEntity pipelineBuild); + public void removeExecutionForObservation(PipelineBuildEntity pipelineBuild); public List getAllAttachedExecutions(); //subscribe for specific build - public void subscribe(PipelineBuild pipelineBuild, PipelineExecutionObserver subscriber); - public void unsubscribe(PipelineBuild pipelineBuild, PipelineExecutionObserver unsubscriber); + public void subscribe(PipelineBuildEntity pipelineBuild, PipelineExecutionObserver subscriber); + public void unsubscribe(PipelineBuildEntity pipelineBuild, PipelineExecutionObserver unsubscriber); - public List getAllSpecificSubscribedObservers(PipelineBuild pipelineBuild); + public List getAllSpecificSubscribedObservers(PipelineBuildEntity pipelineBuild); //subscribe for any build public void subscribe(PipelineExecutionObserver subscriber); @@ -32,5 +32,5 @@ public interface PipelineExecutionObservable { public List getAllGeneralSubscribedObservers(); // notify observers - public void notify(PipelineBuild pipelineBuild); + public void notify(PipelineBuildEntity pipelineBuild); } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/PipelineExecutionObserver.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/PipelineExecutionObserver.java index 874c6cb78..d00c7186a 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/PipelineExecutionObserver.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/PipelineExecutionObserver.java @@ -1,6 +1,6 @@ package com.autobuild.pipeline.executor.execution.observer; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; /** * Pipeline ongoing build (or execution) observer interface. @@ -8,5 +8,5 @@ * @author Suvabrata Chowdhury */ public interface PipelineExecutionObserver { - public void update(PipelineBuild pipelineBuild); + public void update(PipelineBuildEntity pipelineBuild); } \ No newline at end of file diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/impl/PipelineExecutionObservableImpl.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/impl/PipelineExecutionObservableImpl.java index 6f8398f2a..33d2466b3 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/impl/PipelineExecutionObservableImpl.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/observer/impl/PipelineExecutionObservableImpl.java @@ -6,7 +6,7 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.CopyOnWriteArrayList; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObservable; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObserver; @@ -23,7 +23,7 @@ public class PipelineExecutionObservableImpl implements PipelineExecutionObserva // Todo: may not be required @Override - public void attachExecutionForObservation(PipelineBuild pipelineBuild) { + public void attachExecutionForObservation(PipelineBuildEntity pipelineBuild) { if (specificSubscribers.containsKey(pipelineBuild.getId())) { throw new IllegalArgumentException("Build is already being observed"); } @@ -33,7 +33,7 @@ public void attachExecutionForObservation(PipelineBuild pipelineBuild) { // todo: may not be required @Override - public void removeExecutionForObservation(PipelineBuild pipelineBuild) { + public void removeExecutionForObservation(PipelineBuildEntity pipelineBuild) { specificSubscribers.remove(pipelineBuild.getId()); } @@ -43,7 +43,7 @@ public List getAllAttachedExecutions() { } @Override - public void subscribe(PipelineBuild pipelineBuild, PipelineExecutionObserver subscriber) { + public void subscribe(PipelineBuildEntity pipelineBuild, PipelineExecutionObserver subscriber) { if (null == subscriber || null == pipelineBuild) { throw new IllegalArgumentException("Null arguments given"); } @@ -54,7 +54,7 @@ public void subscribe(PipelineBuild pipelineBuild, PipelineExecutionObserver sub } @Override - public void unsubscribe(PipelineBuild pipelineBuild, PipelineExecutionObserver unsubscriber) { + public void unsubscribe(PipelineBuildEntity pipelineBuild, PipelineExecutionObserver unsubscriber) { if (null == unsubscriber || null == pipelineBuild) { throw new IllegalArgumentException("Null arguments given"); } @@ -66,7 +66,7 @@ public void unsubscribe(PipelineBuild pipelineBuild, PipelineExecutionObserver u } @Override - public List getAllSpecificSubscribedObservers(PipelineBuild pipelineBuild) { + public List getAllSpecificSubscribedObservers(PipelineBuildEntity pipelineBuild) { return specificSubscribers.get(pipelineBuild.getId()); } @@ -94,7 +94,7 @@ public List getAllGeneralSubscribedObservers() { } @Override - public void notify(PipelineBuild pipelineBuild) { + public void notify(PipelineBuildEntity pipelineBuild) { if (null == pipelineBuild) { throw new IllegalArgumentException("Null pipeline build given"); } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/PipelineExecutionState.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/PipelineEntityExecutionState.java similarity index 91% rename from pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/PipelineExecutionState.java rename to pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/PipelineEntityExecutionState.java index 4f6b8b409..fa808524d 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/PipelineExecutionState.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/PipelineEntityExecutionState.java @@ -5,13 +5,12 @@ /** * Pipeline Build / execution state. - * + * * @author Suvabrata Chowdhury */ - @AllArgsConstructor @Getter -public enum PipelineExecutionState { +public enum PipelineEntityExecutionState { WAITING("Pipeline is waiting to be executed."), RUNNING("Pipeline execution has started."), SUCCESS("Pipeline execution has finished and it succeeded."), diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/StageExecutionState.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/StageEntityExecutionState.java similarity index 92% rename from pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/StageExecutionState.java rename to pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/StageEntityExecutionState.java index c8b873e1c..4fa1b6f8b 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/StageExecutionState.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/execution/state/StageEntityExecutionState.java @@ -5,13 +5,12 @@ /** * Stage ongoing build (execution) steps. - * + * * @author Suvabrata Chowdhury */ - @AllArgsConstructor @Getter -public enum StageExecutionState { +public enum StageEntityExecutionState { WAITING("Stage is waiting to be executed."), RUNNING("Stage execution has started."), SUCCESS("Stage execution has finished and it succeeded."), diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/job/PipelineExecutor.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/job/PipelineExecutor.java index 76e926a25..9abe8b1b7 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/job/PipelineExecutor.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/job/PipelineExecutor.java @@ -2,7 +2,7 @@ import org.springframework.stereotype.Component; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; /** * Implementation for asynchronously executing a pipeline. @@ -12,5 +12,5 @@ @Component public interface PipelineExecutor { - public void executePipeline(PipelineBuild pipelineBuild); + public void executePipeline(PipelineBuildEntity pipelineBuild); } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/job/impl/PipelineExecutorImpl.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/job/impl/PipelineExecutorImpl.java index 7e2bc86d5..37ad99d2e 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/job/impl/PipelineExecutorImpl.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/job/impl/PipelineExecutorImpl.java @@ -7,22 +7,21 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.scheduling.annotation.Async; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.executor.entity.PipelineBuild; -import com.autobuild.pipeline.executor.entity.StageBuild; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObservable; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; -import com.autobuild.pipeline.executor.execution.state.StageExecutionState; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; +import com.autobuild.pipeline.executor.execution.state.StageEntityExecutionState; import com.autobuild.pipeline.executor.job.PipelineExecutor; import lombok.extern.slf4j.Slf4j; /** * Implementation for asynchronously start executing pipeline build. - * + * * @author Suvabrata Chowdhury */ - @Slf4j public class PipelineExecutorImpl implements PipelineExecutor { @@ -31,10 +30,10 @@ public class PipelineExecutorImpl implements PipelineExecutor { @Async("executorService") @Override - public void executePipeline(PipelineBuild pipelineBuild) { + public void executePipeline(PipelineBuildEntity pipelineBuild) { try { log.info("inside executor impl submit"); - pipelineBuild.setCurrentState(PipelineExecutionState.WAITING); + pipelineBuild.setCurrentState(PipelineEntityExecutionState.WAITING); pipelineExecutionObservable.attachExecutionForObservation(pipelineBuild); this.startBuild(pipelineBuild); @@ -45,25 +44,25 @@ public void executePipeline(PipelineBuild pipelineBuild) { } } - private void startBuild(PipelineBuild pipelineBuild) throws IOException, InterruptedException { - Pipeline pipeline = pipelineBuild.getPipeline(); + private void startBuild(PipelineBuildEntity pipelineBuild) throws IOException, InterruptedException { + PipelineEntity pipeline = pipelineBuild.getPipeline(); log.info("Starting Build for: " + pipeline.getId()); startPipelineStageBuilds(pipelineBuild); } // TODO: Ugly design for now. Refactor later. - private void startPipelineStageBuilds(PipelineBuild pipelineBuild) throws IOException, InterruptedException { + private void startPipelineStageBuilds(PipelineBuildEntity pipelineBuild) throws IOException, InterruptedException { // TODO: with state manager. Finite State Machine - setPipelineBuildState(pipelineBuild, PipelineExecutionState.RUNNING); + setPipelineBuildState(pipelineBuild, PipelineEntityExecutionState.RUNNING); boolean anyStageBuildFailed = false; - for (final StageBuild stageBuild : pipelineBuild.getStageBuilds()) { + for (final StageBuildEntity stageBuild : pipelineBuild.getStageBuilds()) { if (anyStageBuildFailed) { - stageBuild.setCurrentState(StageExecutionState.STOPPED); + stageBuild.setCurrentState(StageEntityExecutionState.STOPPED); continue; } @@ -71,32 +70,32 @@ private void startPipelineStageBuilds(PipelineBuild pipelineBuild) throws IOExce // String logPath = pipelineFileService.createLogFile(pipelineBuild.getId(), stageBuild.getId()); Process stageProcess = startStageProcess(stageBuild); - setStageBuildState(pipelineBuild, stageBuild, StageExecutionState.RUNNING); + setStageBuildState(pipelineBuild, stageBuild, StageEntityExecutionState.RUNNING); log.info("process started with id: " + stageProcess.pid()); int processExitCode = stageProcess.waitFor(); if (processExitCode != 0) { anyStageBuildFailed = true; - stageBuild.setCurrentState(StageExecutionState.FAILED); + stageBuild.setCurrentState(StageEntityExecutionState.FAILED); log.error("process exited with id: " + stageProcess.pid()); continue; } - setStageBuildState(pipelineBuild, stageBuild, StageExecutionState.SUCCESS); + setStageBuildState(pipelineBuild, stageBuild, StageEntityExecutionState.SUCCESS); } if (anyStageBuildFailed) { - pipelineBuild.setCurrentState(PipelineExecutionState.FAILED); + pipelineBuild.setCurrentState(PipelineEntityExecutionState.FAILED); } else { - pipelineBuild.setCurrentState(PipelineExecutionState.SUCCESS); + pipelineBuild.setCurrentState(PipelineEntityExecutionState.SUCCESS); } pipelineExecutionObservable.notify(pipelineBuild); } - private Process startStageProcess(final StageBuild stageBuild) throws IOException { + private Process startStageProcess(final StageBuildEntity stageBuild) throws IOException { ProcessBuilder stageProcessBuilder = new ProcessBuilder(stageBuild.getStage().getPath()); stageProcessBuilder.redirectOutput(Redirect.to(Path.of(stageBuild.getLogPath()).toFile())); @@ -106,14 +105,15 @@ private Process startStageProcess(final StageBuild stageBuild) throws IOExceptio return stageProcess; } - private void setStageBuildState(PipelineBuild pipelineBuild, final StageBuild stageBuild, - final StageExecutionState stageExecutionState) { + private void setStageBuildState(PipelineBuildEntity pipelineBuild, final StageBuildEntity stageBuild, + final StageEntityExecutionState stageExecutionState) { stageBuild.setCurrentState(stageExecutionState); pipelineExecutionObservable.notify(pipelineBuild); } - private void setPipelineBuildState(PipelineBuild pipelineBuild, PipelineExecutionState pipelineExecutionState) { + private void setPipelineBuildState( + PipelineBuildEntity pipelineBuild, PipelineEntityExecutionState pipelineExecutionState) { pipelineBuild.setCurrentState(pipelineExecutionState); pipelineExecutionObservable.notify(pipelineBuild); } -} \ No newline at end of file +} 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 00741a862..aed4f907c 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 @@ -5,7 +5,7 @@ import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; /** * Repository layer for PipelineBuild. @@ -14,6 +14,6 @@ */ @Repository -public interface PipelineBuildRepository extends JpaRepository{ +public interface PipelineBuildRepository extends JpaRepository{ } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/repository/StageBuildRepository.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/repository/StageBuildRepository.java index fa8de6712..d23ce747a 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/repository/StageBuildRepository.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/repository/StageBuildRepository.java @@ -5,7 +5,7 @@ import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; -import com.autobuild.pipeline.executor.entity.StageBuild; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; /** * Repository for Stage Builds. @@ -14,6 +14,6 @@ */ @Repository -public interface StageBuildRepository extends JpaRepository{ +public interface StageBuildRepository extends JpaRepository{ } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildContinuousUpdatorService.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildContinuousUpdatorService.java index 1483202af..376c6348d 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildContinuousUpdatorService.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildContinuousUpdatorService.java @@ -6,7 +6,7 @@ import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObservable; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObserver; import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; @@ -42,10 +42,10 @@ public PipelineBuildContinuousUpdatorService() { @Transactional @Override - public void update(PipelineBuild pipelineBuild) { + public void update(PipelineBuildEntity pipelineBuild) { log.info("Updating build with state: " + pipelineBuild.getCurrentState()); - Optional optionalBuild = repository.findById(pipelineBuild.getId()); + Optional optionalBuild = repository.findById(pipelineBuild.getId()); if (optionalBuild.isEmpty()) { throw new EntityNotFoundException("Pipeline build with id " + pipelineBuild.getId() + " does not exist"); diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildLiveService.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildLiveService.java index 8934fbd85..693506628 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildLiveService.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildLiveService.java @@ -13,10 +13,10 @@ import org.springframework.web.servlet.mvc.method.annotation.SseEmitter; import com.autobuild.pipeline.executor.dto.mapper.PipelineBuildMapper; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObservable; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObserver; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; import jakarta.annotation.PreDestroy; @@ -26,10 +26,9 @@ /** * Service for sending SSE on change of pipeline or it's stages. Implemented as * an Observer. - * + * * @author Suvabrata Chowdhury */ - @Slf4j @Service public class PipelineBuildLiveService implements PipelineExecutionObserver { @@ -63,7 +62,7 @@ public void addSubscriber(SseEmitter newSubscriber, UUID pipelineBuildId) { return emitters; }); - Optional optionalPipelineBuild = repository.findById(pipelineBuildId); + Optional optionalPipelineBuild = repository.findById(pipelineBuildId); if (optionalPipelineBuild.isEmpty()) { EntityNotFoundException entityNotFoundException = new EntityNotFoundException( @@ -72,7 +71,7 @@ public void addSubscriber(SseEmitter newSubscriber, UUID pipelineBuildId) { throw entityNotFoundException; } - if (!optionalPipelineBuild.get().getCurrentState().equals(PipelineExecutionState.RUNNING)) { + if (!optionalPipelineBuild.get().getCurrentState().equals(PipelineEntityExecutionState.RUNNING)) { UnsupportedOperationException exception = new UnsupportedOperationException( "Live broadcast is not suppoerted as build is not in running state"); newSubscriber.completeWithError(exception); @@ -101,7 +100,7 @@ public void addSubscriber(SseEmitter newSubscriber, UUID pipelineBuildId) { } @Override - public void update(PipelineBuild pipelineBuild) { + public void update(PipelineBuildEntity pipelineBuild) { List subscriberEmitters = liveSubscribers.get(pipelineBuild.getId()); List deadEmitters = new ArrayList<>(); @@ -111,8 +110,8 @@ public void update(PipelineBuild pipelineBuild) { try { subscriberEmitter.send(SseEmitter.event().data(mapper.entityToDto(pipelineBuild))); - if (pipelineBuild.getCurrentState().equals(PipelineExecutionState.SUCCESS) - || pipelineBuild.getCurrentState().equals(PipelineExecutionState.FAILED)) { + if (pipelineBuild.getCurrentState().equals(PipelineEntityExecutionState.SUCCESS) + || pipelineBuild.getCurrentState().equals(PipelineEntityExecutionState.FAILED)) { subscriberEmitter.complete(); deadEmitters.add(subscriberEmitter); } @@ -170,4 +169,4 @@ public void forceCloseAllEmitters() { }); liveSubscribers.clear(); } -} \ No newline at end of file +} diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildService.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildService.java index eb682e830..befb2938d 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildService.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/PipelineBuildService.java @@ -8,10 +8,10 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; import com.autobuild.pipeline.executor.dto.mapper.PipelineBuildMapper; -import com.autobuild.pipeline.executor.entity.PipelineBuild; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; import com.autobuild.pipeline.utility.file.PipelineFileService; @@ -20,10 +20,9 @@ /** * Service for Pipeline Build. - * + * * @author Suvabrata Chowdhury */ - @Slf4j @Service public class PipelineBuildService { @@ -37,8 +36,8 @@ public class PipelineBuildService { @Autowired private PipelineFileService pipelineFileService; - public PipelineBuildDTO getPipelineBuild(UUID pipelineBuildId) { - Optional optionalPipelineBuild = repository.findById(pipelineBuildId); + public PipelineBuild getPipelineBuild(UUID pipelineBuildId) { + Optional optionalPipelineBuild = repository.findById(pipelineBuildId); if (optionalPipelineBuild.isEmpty()) { EntityNotFoundException entityNotFoundException = new EntityNotFoundException( @@ -49,28 +48,28 @@ public PipelineBuildDTO getPipelineBuild(UUID pipelineBuildId) { return mapper.entityToDto(optionalPipelineBuild.get()); } - public List getAllBuilds() { - List builds = repository.findAll(); + public List getAllBuilds() { + List builds = repository.findAll(); log.info("Fetched all pipeline builds, count: {}", builds.size()); return builds.stream() .map(pipeline -> { - PipelineBuildDTO dto = mapper.entityToDto(pipeline); + PipelineBuild dto = mapper.entityToDto(pipeline); return dto; }) .toList(); } public void deletePipelineBuild(UUID pipelineBuildId) throws IOException { - Optional optionalPipelineBuild = repository.findById(pipelineBuildId); + Optional optionalPipelineBuild = repository.findById(pipelineBuildId); if (optionalPipelineBuild.isEmpty()) { throw new EntityNotFoundException( "Pipeline Build with id: " + pipelineBuildId + " does not exist"); } - PipelineBuild pipelineBuild = optionalPipelineBuild.get(); - if (pipelineBuild.getCurrentState().equals(PipelineExecutionState.RUNNING) - || pipelineBuild.getCurrentState().equals(PipelineExecutionState.WAITING)) { + PipelineBuildEntity pipelineBuild = optionalPipelineBuild.get(); + if (pipelineBuild.getCurrentState().equals(PipelineEntityExecutionState.RUNNING) + || pipelineBuild.getCurrentState().equals(PipelineEntityExecutionState.WAITING)) { throw new IllegalStateException("Running or Waiting Pipelines can not be deleted"); } 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 53dcbac33..da08a582f 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 @@ -11,13 +11,13 @@ import org.springframework.transaction.support.TransactionSynchronization; import org.springframework.transaction.support.TransactionSynchronizationManager; -import com.autobuild.pipeline.definiton.entity.Pipeline; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; 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.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; import com.autobuild.pipeline.executor.job.PipelineExecutor; import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; import com.autobuild.pipeline.utility.file.PipelineFileService; @@ -53,21 +53,21 @@ public class PipelineExecutorService { private PipelineFileService pipelineFileService; @Transactional - public PipelineBuildDTO executePipeline(PipelineExecuteRequest pipelineRequest) throws IOException { + public PipelineBuild executePipeline(PipelineExecuteRequest pipelineRequest) throws IOException { UUID pipelineId = pipelineRequest.getPipelineId(); - Optional optionalPipeline = pipelineRepository.findById(pipelineId); + Optional optionalPipeline = pipelineRepository.findById(pipelineId); if (optionalPipeline.isEmpty()) { throw new EntityNotFoundException("Pipeline with id " + pipelineId + " not found"); } - Pipeline pipeline = optionalPipeline.get(); - PipelineBuild pipelineBuild = createBuild(pipeline); + PipelineEntity pipeline = optionalPipeline.get(); + PipelineBuildEntity pipelineBuild = createBuild(pipeline); createEmptyLogFiles(pipelineBuild); - PipelineBuild savedBuild = buildRepository.save(pipelineBuild); + PipelineBuildEntity savedBuild = buildRepository.save(pipelineBuild); // Strictly run executing pipeline after build is commited TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() { @@ -80,8 +80,8 @@ public void afterCommit() { return mapper.entityToDto(savedBuild); } - private void createEmptyLogFiles(PipelineBuild pipelineBuild) throws IOException { - for (StageBuild stageBuild : pipelineBuild.getStageBuilds()) { + private void createEmptyLogFiles(PipelineBuildEntity pipelineBuild) throws IOException { + for (StageBuildEntity stageBuild : pipelineBuild.getStageBuilds()) { try { stageBuild.setLogPath(pipelineFileService.createLogFile(pipelineBuild.getId(), stageBuild.getId())); } catch (IOException e) { @@ -91,17 +91,17 @@ private void createEmptyLogFiles(PipelineBuild pipelineBuild) throws IOException } // 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()); + private PipelineBuildEntity createBuild(final PipelineEntity pipeline) { + List stageBuilds = pipeline.getStages() + .stream() + .map(stage -> { + StageBuildEntity stageBuild = new StageBuildEntity(stage); + stageBuild.setId(UUID.randomUUID()); - return stageBuild; - }).toList(); + return stageBuild; + }).toList(); - PipelineBuild pipelineBuild = new PipelineBuild(pipeline, stageBuilds); + PipelineBuildEntity pipelineBuild = new PipelineBuildEntity(pipeline, stageBuilds); pipelineBuild.setId(UUID.randomUUID()); return pipelineBuild; diff --git a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/StageBuildService.java b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/StageBuildService.java index 0c3024ab7..c49b4d866 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/executor/service/StageBuildService.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/executor/service/StageBuildService.java @@ -8,7 +8,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; -import com.autobuild.pipeline.executor.entity.StageBuild; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; import com.autobuild.pipeline.executor.repository.StageBuildRepository; import com.autobuild.pipeline.utility.file.PipelineFileService; @@ -30,7 +30,7 @@ public class StageBuildService { private StageBuildRepository repository; public Map getStageBuildLogs(UUID stageBuildId) throws IOException { - Optional optionalStageBuild = repository.findById(stageBuildId); + Optional optionalStageBuild = repository.findById(stageBuildId); if (optionalStageBuild.isEmpty()) { throw new EntityNotFoundException( diff --git a/pipeline/src/main/java/com/autobuild/pipeline/utility/file/PipelineFileService.java b/pipeline/src/main/java/com/autobuild/pipeline/utility/file/PipelineFileService.java index cb3115237..22b32e9c6 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/utility/file/PipelineFileService.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/utility/file/PipelineFileService.java @@ -4,12 +4,12 @@ import java.util.Map; import java.util.UUID; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.dto.StageDTO; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.definiton.entity.Stage; -import com.autobuild.pipeline.executor.entity.PipelineBuild; -import com.autobuild.pipeline.executor.entity.StageBuild; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.definiton.entity.StageEntity; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; +import com.autobuild.pipeline.definiton.gen.dto.Stage; /** * General Interface for any file related operations for pipeline. @@ -17,17 +17,17 @@ * @author Suvabrata Chowdhury */ public interface PipelineFileService { - public Map readScriptFiles(final Pipeline pipeline) throws IOException; - public Map createScriptFiles(final PipelineDTO pipeline) throws IOException; - public void removeScriptFiles(final PipelineDTO pipeline) throws IOException; + public Map readScriptFiles(final PipelineEntity pipeline) throws IOException; + public Map createScriptFiles(final Pipeline pipeline) throws IOException; public void removeScriptFiles(final Pipeline pipeline) throws IOException; + public void removeScriptFiles(final PipelineEntity pipeline) throws IOException; - public String createStageScriptFile(final Pipeline pipeline, final StageDTO stage) throws IOException; - public void updateStageScriptFile(final Stage stage, final String command) throws IOException; - public void removeStageScriptFile(final Stage stage) throws IOException; - String readStageScriptFile(final Stage stage) throws IOException; + public String createStageScriptFile(final PipelineEntity pipeline, final Stage stage) throws IOException; + public void updateStageScriptFile(final StageEntity stage, final String command) throws IOException; + public void removeStageScriptFile(final StageEntity stage) throws IOException; + String readStageScriptFile(final StageEntity stage) throws IOException; public String createLogFile(final UUID pipelineBuildId, final UUID stageBuildId) throws IOException; - public void removeLogFiles(final PipelineBuild pipelineBuid) throws IOException; - public String readStageBuildLogFile(StageBuild stageBuild) throws IOException; + public void removeLogFiles(final PipelineBuildEntity pipelineBuid) throws IOException; + public String readStageBuildLogFile(StageBuildEntity stageBuild) throws IOException; } diff --git a/pipeline/src/main/java/com/autobuild/pipeline/utility/file/impl/LocalPipelineFileServiceImpl.java b/pipeline/src/main/java/com/autobuild/pipeline/utility/file/impl/LocalPipelineFileServiceImpl.java index 10d519316..1ba678872 100644 --- a/pipeline/src/main/java/com/autobuild/pipeline/utility/file/impl/LocalPipelineFileServiceImpl.java +++ b/pipeline/src/main/java/com/autobuild/pipeline/utility/file/impl/LocalPipelineFileServiceImpl.java @@ -17,12 +17,12 @@ import org.apache.commons.lang3.StringUtils; import org.springframework.stereotype.Component; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.dto.StageDTO; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.definiton.entity.Stage; -import com.autobuild.pipeline.executor.entity.PipelineBuild; -import com.autobuild.pipeline.executor.entity.StageBuild; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.definiton.entity.StageEntity; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; +import com.autobuild.pipeline.definiton.gen.dto.Stage; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; import com.autobuild.pipeline.utility.file.PipelineFileService; import com.autobuild.pipeline.utility.file.extension.Extensions; @@ -55,7 +55,7 @@ public class LocalPipelineFileServiceImpl implements PipelineFileService { PosixFilePermission.OWNER_READ)); @Override - public Map readScriptFiles(final Pipeline pipeline) throws IOException { + public Map readScriptFiles(final PipelineEntity pipeline) throws IOException { Map scriptContents = new HashMap<>(); try { @@ -79,16 +79,16 @@ public Map readScriptFiles(final Pipeline pipeline) throws IOExcep } @Override - public Map createScriptFiles(final PipelineDTO pipeline) throws IOException { + public Map createScriptFiles(final Pipeline pipeline) throws IOException { createParentDirectory(); Path directoryPath = createPipelineDirectory(pipeline); Map scriptPaths = new HashMap<>(); - for (StageDTO stage : pipeline.getStages()) { + for (Stage stage : pipeline.getStagesList()) { String path = createStageFile(directoryPath, stage); - scriptPaths.put(stage.getId(), path); + scriptPaths.put(UUID.fromString(stage.getId()), path); } return scriptPaths; @@ -99,8 +99,8 @@ public Map createScriptFiles(final PipelineDTO pipeline) throws IO */ @Override - public void removeScriptFiles(final PipelineDTO pipeline) throws IOException { - Path directoryPath = getPipelineDirectoryPath(pipeline.getId().toString()); + public void removeScriptFiles(final Pipeline pipeline) throws IOException { + Path directoryPath = getPipelineDirectoryPath(pipeline.getId()); try (Stream paths = Files.walk(directoryPath)) { paths.sorted(Comparator.reverseOrder()).forEach(path -> { @@ -120,7 +120,7 @@ public void removeScriptFiles(final PipelineDTO pipeline) throws IOException { */ @Override - public void removeScriptFiles(final Pipeline pipeline) throws IOException { + public void removeScriptFiles(final PipelineEntity pipeline) throws IOException { try { pipeline.getStages().forEach(stage -> { try { @@ -137,7 +137,7 @@ public void removeScriptFiles(final Pipeline pipeline) throws IOException { } @Override - public String createStageScriptFile(Pipeline pipeline, StageDTO stage) throws IOException { + public String createStageScriptFile(PipelineEntity pipeline, Stage stage) throws IOException { createParentDirectory(); Path pipelineDirectoryPath = getPipelineDirectoryPath(pipeline.getId().toString()); @@ -149,18 +149,18 @@ public String createStageScriptFile(Pipeline pipeline, StageDTO stage) throws IO } @Override - public void updateStageScriptFile(Stage stage, String command) throws IOException { + public void updateStageScriptFile(StageEntity stage, String command) throws IOException { Path filePath = Path.of(stage.getPath()); Files.write(filePath, command.getBytes()); } @Override - public void removeStageScriptFile(Stage stage) throws IOException { + public void removeStageScriptFile(StageEntity stage) throws IOException { Files.deleteIfExists(Path.of(stage.getPath())); } @Override - public String readStageScriptFile(final Stage stage) throws IOException { + public String readStageScriptFile(final StageEntity stage) throws IOException { if (stage == null || StringUtils.isBlank(stage.getPath())) { return ""; } @@ -180,8 +180,8 @@ public String createLogFile(UUID pipelineBuildId, UUID stageBuildId) throws IOEx } @Override - public void removeLogFiles(final PipelineBuild pipelineBuid) throws IOException { - for (StageBuild stageBuild : pipelineBuid.getStageBuilds()) { + public void removeLogFiles(final PipelineBuildEntity pipelineBuid) throws IOException { + for (StageBuildEntity stageBuild : pipelineBuid.getStageBuilds()) { Files.deleteIfExists(Path.of(stageBuild.getLogPath())); } @@ -189,7 +189,7 @@ public void removeLogFiles(final PipelineBuild pipelineBuid) throws IOException } @Override - public String readStageBuildLogFile(StageBuild stageBuild) throws IOException { + public String readStageBuildLogFile(StageBuildEntity stageBuild) throws IOException { if (stageBuild == null || StringUtils.isBlank(stageBuild.getLogPath())) { throw new IllegalArgumentException("Invalid stageBuild given for log reading"); } @@ -221,14 +221,14 @@ private void createParentDirectory() throws IOException { } } - private Path createPipelineDirectory(PipelineDTO pipeline) throws IOException { - Path directoryPath = getPipelineDirectoryPath(pipeline.getId().toString()); + private Path createPipelineDirectory(Pipeline pipeline) throws IOException { + Path directoryPath = getPipelineDirectoryPath(pipeline.getId()); directoryPath = Files.createDirectories(directoryPath, PERMISSIONS); return directoryPath; } - private String createStageFile(Path directoryPath, StageDTO stage) throws IOException { + private String createStageFile(Path directoryPath, Stage stage) throws IOException { String scriptName = stage.getId() + Extensions.nameFor(stage.getScriptType()); Path filePath = directoryPath.resolve(scriptName); diff --git a/pipeline/src/test/java/com/autobuild/pipeline/auth/security/DefaultSecurityConfigTest.java b/pipeline/src/test/java/com/autobuild/pipeline/auth/security/DefaultSecurityConfigTest.java index f3ce371ae..2d4996afb 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/auth/security/DefaultSecurityConfigTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/auth/security/DefaultSecurityConfigTest.java @@ -34,11 +34,10 @@ public void setup() throws Exception { @Test void testDefaultSecurity() throws Exception { localSecurityConfig.defaultSecurityFilterChain(mockHttpSecurity); - - verify(mockHttpSecurity,times(1)).csrf(any()); - verify(mockHttpSecurity,times(1)).authorizeHttpRequests(any()); - verify(mockHttpSecurity,times(1)).headers(any()); - verify(mockHttpSecurity,times(1)).httpBasic(any()); - verify(mockHttpSecurity,times(1)).formLogin(any()); + verify(mockHttpSecurity, times(1)).csrf(any()); + verify(mockHttpSecurity, times(1)).authorizeHttpRequests(any()); + verify(mockHttpSecurity, times(1)).headers(any()); + verify(mockHttpSecurity, times(1)).httpBasic(any()); + verify(mockHttpSecurity, times(1)).formLogin(any()); } } diff --git a/pipeline/src/test/java/com/autobuild/pipeline/configuration/ProtobufOpenApiCustomizerTest.java b/pipeline/src/test/java/com/autobuild/pipeline/configuration/ProtobufOpenApiCustomizerTest.java new file mode 100644 index 000000000..a7c85daa3 --- /dev/null +++ b/pipeline/src/test/java/com/autobuild/pipeline/configuration/ProtobufOpenApiCustomizerTest.java @@ -0,0 +1,200 @@ +package com.autobuild.pipeline.configuration; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import io.swagger.v3.oas.models.Components; +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.media.Schema; + +class ProtobufOpenApiCustomizerTest { + + private ProtobufOpenApiCustomizer customizer; + private OpenAPI openApi; + + @BeforeEach + void setUp() { + customizer = new ProtobufOpenApiCustomizer(); + openApi = new OpenAPI(); + } + + @Test + void customise_doesNothing_whenComponentsIsNull() { + customizer.customise(openApi); + } + + @Test + void customise_doesNothing_whenSchemasIsNull() { + openApi.setComponents(new Components()); + customizer.customise(openApi); + } + + @Test + void customise_removesProtoInternalSchemas() { + openApi.setComponents(new Components()); + openApi.getComponents().setSchemas(new HashMap<>()); + openApi.getComponents().getSchemas().put("Pipeline", new Schema<>()); + openApi.getComponents().getSchemas().put("Descriptor", new Schema<>()); + openApi.getComponents().getSchemas().put("ByteString", new Schema<>()); + openApi.getComponents().getSchemas().put("ParserPipeline", new Schema<>()); + + customizer.customise(openApi); + + Map schemas = openApi.getComponents().getSchemas(); + assertTrue(schemas.containsKey("Pipeline")); + assertFalse(schemas.containsKey("Descriptor")); + assertFalse(schemas.containsKey("ByteString")); + assertFalse(schemas.containsKey("ParserPipeline")); + } + + @Test + void customise_stripsProtoInternalPropertiesFromPipelineSchema() { + Schema pipelineSchema = new Schema<>(); + pipelineSchema.setProperties(new HashMap<>()); + pipelineSchema.getProperties().put("id", new Schema<>()); + pipelineSchema.getProperties().put("name", new Schema<>()); + pipelineSchema.getProperties().put("stagesList", new Schema<>()); + pipelineSchema.getProperties().put("serializedSize", new Schema<>()); + pipelineSchema.getProperties().put("unknownFields", new Schema<>()); + + openApi.setComponents(new Components()); + openApi.getComponents().setSchemas(new HashMap<>()); + openApi.getComponents().getSchemas().put("Pipeline", pipelineSchema); + + customizer.customise(openApi); + + Map props = openApi.getComponents().getSchemas().get("Pipeline").getProperties(); + assertTrue(props.containsKey("id")); + assertTrue(props.containsKey("name")); + assertFalse(props.containsKey("serializedSize")); + assertFalse(props.containsKey("unknownFields")); + } + + @Test + void customise_renamesStagesToStagesList() { + Schema pipelineSchema = new Schema<>(); + pipelineSchema.setProperties(new HashMap<>()); + Schema stagesListSchema = new Schema<>(); + pipelineSchema.getProperties().put("stagesList", stagesListSchema); + + openApi.setComponents(new Components()); + openApi.getComponents().setSchemas(new HashMap<>()); + openApi.getComponents().getSchemas().put("Pipeline", pipelineSchema); + + customizer.customise(openApi); + + Map props = openApi.getComponents().getSchemas().get("Pipeline").getProperties(); + assertTrue(props.containsKey("stages")); + assertFalse(props.containsKey("stagesList")); + assertEquals(stagesListSchema, props.get("stages")); + } + + @Test + void customise_renamesStageBuildsList() { + Schema buildSchema = new Schema<>(); + buildSchema.setProperties(new HashMap<>()); + buildSchema.getProperties().put("stageBuildsList", new Schema<>()); + + openApi.setComponents(new Components()); + openApi.getComponents().setSchemas(new HashMap<>()); + openApi.getComponents().getSchemas().put("PipelineBuild", buildSchema); + + customizer.customise(openApi); + + Map props = openApi.getComponents().getSchemas().get("PipelineBuild").getProperties(); + assertTrue(props.containsKey("stageBuilds")); + assertFalse(props.containsKey("stageBuildsList")); + } + + @Test + void customise_stripsEnumPrefixAndRemovesUnrecognized() { + Schema buildSchema = new Schema<>(); + buildSchema.setProperties(new HashMap<>()); + Schema stateSchema = new Schema<>(); + List enumValues = new ArrayList<>(); + enumValues.add("PIPELINE_WAITING"); + enumValues.add("PIPELINE_RUNNING"); + enumValues.add("PIPELINE_SUCCESS"); + enumValues.add("PIPELINE_FAILED"); + enumValues.add("UNRECOGNIZED"); + stateSchema.setEnum(enumValues); + buildSchema.getProperties().put("currentState", stateSchema); + + openApi.setComponents(new Components()); + openApi.getComponents().setSchemas(new HashMap<>()); + openApi.getComponents().getSchemas().put("PipelineBuild", buildSchema); + + customizer.customise(openApi); + + @SuppressWarnings("unchecked") + List result = ((Schema) openApi.getComponents().getSchemas() + .get("PipelineBuild").getProperties().get("currentState")).getEnum(); + assertTrue(result.contains("SUCCESS")); + assertTrue(result.contains("RUNNING")); + assertFalse(result.contains("PIPELINE_SUCCESS")); + assertFalse(result.contains("UNRECOGNIZED")); + } + + @Test + void customise_sortsSchemasAlphabetically() { + openApi.setComponents(new Components()); + openApi.getComponents().setSchemas(new LinkedHashMap<>()); + openApi.getComponents().getSchemas().put("Stage", new Schema<>()); + openApi.getComponents().getSchemas().put("Pipeline", new Schema<>()); + openApi.getComponents().getSchemas().put("StageBuild", new Schema<>()); + openApi.getComponents().getSchemas().put("PipelineBuild", new Schema<>()); + + customizer.customise(openApi); + + List keys = new ArrayList<>(openApi.getComponents().getSchemas().keySet()); + assertEquals("Pipeline", keys.get(0)); + assertEquals("PipelineBuild", keys.get(1)); + assertEquals("Stage", keys.get(2)); + assertEquals("StageBuild", keys.get(3)); + } + + @Test + @SuppressWarnings("unchecked") + void customise_sortsPropertiesWithinSchemaAlphabetically() { + Schema stageSchema = new Schema<>(); + stageSchema.setProperties(new LinkedHashMap<>()); + stageSchema.getProperties().put("stageOrder", new Schema<>()); + stageSchema.getProperties().put("id", new Schema<>()); + stageSchema.getProperties().put("name", new Schema<>()); + stageSchema.getProperties().put("scriptType", new Schema<>()); + + openApi.setComponents(new Components()); + openApi.getComponents().setSchemas(new HashMap<>()); + openApi.getComponents().getSchemas().put("Stage", stageSchema); + + customizer.customise(openApi); + + List propKeys = new ArrayList<>(openApi.getComponents().getSchemas().get("Stage").getProperties().keySet()); + assertEquals("id", propKeys.get(0)); + assertEquals("name", propKeys.get(1)); + assertEquals("scriptType", propKeys.get(2)); + assertEquals("stageOrder", propKeys.get(3)); + } + + @Test + void customise_handlesSchemaWithNullProperties() { + openApi.setComponents(new Components()); + openApi.getComponents().setSchemas(new HashMap<>()); + openApi.getComponents().getSchemas().put("Pipeline", new Schema<>()); + + customizer.customise(openApi); + + assertNull(openApi.getComponents().getSchemas().get("Pipeline").getProperties()); + } +} diff --git a/pipeline/src/test/java/com/autobuild/pipeline/definition/controller/PipelineControllerTest.java b/pipeline/src/test/java/com/autobuild/pipeline/definition/controller/PipelineControllerTest.java index 54185229c..7f1030ea7 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/definition/controller/PipelineControllerTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/definition/controller/PipelineControllerTest.java @@ -11,7 +11,6 @@ import static org.mockito.Mockito.when; import java.io.IOException; -import java.util.ArrayList; import java.util.List; import java.util.UUID; @@ -25,8 +24,8 @@ import com.autobuild.pipeline.configuration.FeatureFlagService; import com.autobuild.pipeline.definiton.controller.PipelineController; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.dto.StageDTO; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; +import com.autobuild.pipeline.definiton.gen.dto.Stage; import com.autobuild.pipeline.definiton.exceptions.DuplicateEntryException; import com.autobuild.pipeline.definiton.exceptions.InvalidIdException; import com.autobuild.pipeline.definiton.service.PipelineService; @@ -36,7 +35,7 @@ public class PipelineControllerTest { - private PipelineDTO pipelineDTO = DummyData.getPipelineDTO(); + private Pipeline pipelineDTO = DummyData.getPipelineDTO(); @Mock private PipelineService pipelineService; @@ -62,16 +61,16 @@ public void testGetPipelineWithNoPipeline() throws InvalidIdException, IOExcepti @Test public void testGetPipelineWithPipeline() throws InvalidIdException, IOException { doReturn(pipelineDTO).when(pipelineService).getPipelineById(anyString()); - ResponseEntity response = controller.getPipelineById("1"); + ResponseEntity response = controller.getPipelineById("1"); assertEquals(HttpStatus.OK, response.getStatusCode()); assertEquals(pipelineDTO, response.getBody()); } @Test public void testGetAllPipelines() { - List pipelines = List.of(pipelineDTO); + List pipelines = List.of(pipelineDTO); doReturn(pipelines).when(pipelineService).getAllPipelines(); - ResponseEntity> response = controller.getAllPipelines(); + ResponseEntity> response = controller.getAllPipelines(); assertEquals(HttpStatus.OK, response.getStatusCode()); assertEquals(pipelines, response.getBody()); } @@ -84,8 +83,8 @@ public void testGetPipelineWithInvalidId() throws InvalidIdException, IOExceptio @Test public void testCreatePipelineWithPipeline() throws DuplicateEntryException, IOException, InvalidIdException { - doReturn(pipelineDTO).when(pipelineService).createPipeline(any(PipelineDTO.class)); - ResponseEntity response = controller.createPipeline(pipelineDTO); + doReturn(pipelineDTO).when(pipelineService).createPipeline(any(Pipeline.class)); + ResponseEntity response = controller.createPipeline(pipelineDTO); assertEquals(HttpStatus.CREATED, response.getStatusCode()); assertEquals(pipelineDTO, response.getBody()); assertEquals("/api/v1/pipeline/" + pipelineDTO.getId(), response.getHeaders().get("location").get(0)); @@ -101,119 +100,113 @@ public void testDeletePipeline() throws IOException, InvalidIdException { @Test public void testModifyPipelineReturnsForbiddenWhenFlagDisabled() throws Exception { when(featureFlagService.getBooleanValue(anyString())).thenReturn(false); - StageDTO newStage = new StageDTO(null, "deploy", "bash", "#!/bin/bash\necho DEPLOY"); - PipelineDTO request = new PipelineDTO(); - request.setStages(new ArrayList<>()); - request.getStages().add(newStage); + Pipeline request = Pipeline.newBuilder() + .addAllStages(List.of(Stage.newBuilder().setName("deploy").setScriptType("bash") + .setCommand("#!/bin/bash\necho DEPLOY").build())) + .build(); - ResponseEntity response = controller.modifyPipeline("pid", request); + ResponseEntity response = controller.modifyPipeline("pid", request); assertEquals(HttpStatus.NOT_IMPLEMENTED, response.getStatusCode()); } @Test public void testModifyPipelineStagesCreate() throws Exception { - StageDTO newStage = new StageDTO(null, "deploy", "bash", "#!/bin/bash\necho DEPLOY"); - PipelineDTO modified = DummyData.getPipelineDTO(); - modified.setStages(new ArrayList<>(modified.getStages())); - StageDTO createdStage = new StageDTO(UUID.randomUUID(), newStage.getName(), - newStage.getScriptType(), newStage.getCommand()); - modified.getStages().add(createdStage); + Stage newStage = Stage.newBuilder().setName("deploy").setScriptType("bash") + .setCommand("#!/bin/bash\necho DEPLOY").build(); - PipelineDTO request = new PipelineDTO(); - request.setStages(new ArrayList<>()); - request.getStages().add(newStage); + Stage createdStage = Stage.newBuilder().setId(UUID.randomUUID().toString()) + .setName(newStage.getName()).setScriptType(newStage.getScriptType()) + .setCommand(newStage.getCommand()).build(); - doReturn(modified).when(pipelineService).modifyPipeline(eq("pid"), any(PipelineDTO.class)); + Pipeline modified = pipelineDTO.toBuilder().addStages(createdStage).build(); - ResponseEntity response = controller.modifyPipeline("pid", request); + Pipeline request = Pipeline.newBuilder().addAllStages(List.of(newStage)).build(); + + doReturn(modified).when(pipelineService).modifyPipeline(eq("pid"), any(Pipeline.class)); + + ResponseEntity response = controller.modifyPipeline("pid", request); assertEquals(HttpStatus.OK, response.getStatusCode()); - assertEquals(modified.getStages().size(), response.getBody().getStages().size()); + assertEquals(modified.getStagesList().size(), response.getBody().getStagesList().size()); } @Test public void testModifyPipelineStagesUpdate() throws Exception { - PipelineDTO base = DummyData.getPipelineDTO(); - base.setStages(new ArrayList<>(base.getStages())); - StageDTO existing = base.getStages().get(0); - StageDTO updateReq = new StageDTO(existing.getId(), "renamed", - existing.getScriptType(), "#!/bin/bash\necho UPDATED"); - - existing.setName("renamed"); - existing.setCommand(updateReq.getCommand()); + Stage existing = pipelineDTO.getStagesList().get(0); + Stage updated = existing.toBuilder().setName("renamed").setCommand("#!/bin/bash\necho UPDATED").build(); + Pipeline modified = Pipeline.newBuilder() + .setId(pipelineDTO.getId()).setName(pipelineDTO.getName()) + .addAllStages(List.of(updated)).build(); - PipelineDTO request = new PipelineDTO(); - request.setStages(new ArrayList<>()); - request.getStages().add(updateReq); + Pipeline request = Pipeline.newBuilder() + .addAllStages(List.of(Stage.newBuilder().setId(existing.getId()).setName("renamed") + .setScriptType(existing.getScriptType()).setCommand("#!/bin/bash\necho UPDATED").build())) + .build(); - doReturn(base).when(pipelineService).modifyPipeline(eq("pid"), any(PipelineDTO.class)); + doReturn(modified).when(pipelineService).modifyPipeline(eq("pid"), any(Pipeline.class)); - ResponseEntity response = controller.modifyPipeline("pid", request); + ResponseEntity response = controller.modifyPipeline("pid", request); assertEquals(HttpStatus.OK, response.getStatusCode()); - assertEquals("renamed", response.getBody().getStages().get(0).getName()); + assertEquals("renamed", response.getBody().getStagesList().get(0).getName()); } @Test public void testModifyPipelineStagesDelete() throws Exception { - PipelineDTO base = DummyData.getPipelineDTO(); - base.setStages(new ArrayList<>(base.getStages())); - StageDTO toDelete = base.getStages().get(0); - base.getStages().remove(0); + Stage toDelete = pipelineDTO.getStagesList().get(0); + Pipeline modified = Pipeline.newBuilder() + .setId(pipelineDTO.getId()).setName(pipelineDTO.getName()) + .build(); - StageDTO deleteReq = new StageDTO(toDelete.getId(), null, null, null); - PipelineDTO request = new PipelineDTO(); - request.setStages(new ArrayList<>()); - request.getStages().add(deleteReq); + Pipeline request = Pipeline.newBuilder() + .addAllStages(List.of(Stage.newBuilder().setId(toDelete.getId()).build())) + .build(); - doReturn(base).when(pipelineService).modifyPipeline(eq("pid"), any(PipelineDTO.class)); + doReturn(modified).when(pipelineService).modifyPipeline(eq("pid"), any(Pipeline.class)); - ResponseEntity response = controller.modifyPipeline("pid", request); + ResponseEntity response = controller.modifyPipeline("pid", request); assertEquals(HttpStatus.OK, response.getStatusCode()); - boolean present = response.getBody().getStages().stream() - .anyMatch(s -> s.getId().equals(toDelete.getId())); + boolean present = response.getBody().getStagesList().stream() + .anyMatch(s -> s.getId().equals(toDelete.getId())); assertEquals(false, present); } @Test public void testModifyPipelineStagesDuplicateEntry() throws Exception { - StageDTO newStage = new StageDTO(null, "duplicate", "bash", "#!/bin/bash\necho X"); - PipelineDTO request = new PipelineDTO(); - request.setStages(new ArrayList<>()); - request.getStages().add(newStage); + Pipeline request = Pipeline.newBuilder() + .addAllStages(List.of(Stage.newBuilder().setName("duplicate").setScriptType("bash") + .setCommand("#!/bin/bash\necho X").build())) + .build(); doThrow(new DuplicateEntryException("duplicate")).when(pipelineService) - .modifyPipeline(eq("pid"), any(PipelineDTO.class)); + .modifyPipeline(eq("pid"), any(Pipeline.class)); assertThrows(DuplicateEntryException.class, () -> controller.modifyPipeline("pid", request)); } @Test public void testModifyPipelineStagesInvalidId() throws Exception { - StageDTO newStage = new StageDTO(null, "stage", "bash", "#!/bin/bash\necho X"); - PipelineDTO request = new PipelineDTO(); - request.setStages(new ArrayList<>()); - request.getStages().add(newStage); + Pipeline request = Pipeline.newBuilder() + .addAllStages(List.of(Stage.newBuilder().setName("stage").setScriptType("bash") + .setCommand("#!/bin/bash\necho X").build())) + .build(); doThrow(new InvalidIdException("invalid")).when(pipelineService) - .modifyPipeline(eq("pid"), any(PipelineDTO.class)); + .modifyPipeline(eq("pid"), any(Pipeline.class)); assertThrows(InvalidIdException.class, () -> controller.modifyPipeline("pid", request)); } @Test public void testUpdatePipelineName() throws Exception { - PipelineDTO updated = DummyData.getPipelineDTO(); - updated.setName("New Pipeline Name"); + Pipeline updated = pipelineDTO.toBuilder().setName("New Pipeline Name").build(); + Pipeline request = Pipeline.newBuilder().setName("New Pipeline Name").build(); - PipelineDTO request = new PipelineDTO(); - request.setName("New Pipeline Name"); + doReturn(updated).when(pipelineService).modifyPipeline(eq("pid"), any(Pipeline.class)); - doReturn(updated).when(pipelineService).modifyPipeline(eq("pid"), any(PipelineDTO.class)); - - ResponseEntity response = controller.modifyPipeline("pid", request); + ResponseEntity response = controller.modifyPipeline("pid", request); assertEquals(HttpStatus.OK, response.getStatusCode()); assertEquals("New Pipeline Name", response.getBody().getName()); @@ -221,138 +214,125 @@ public void testUpdatePipelineName() throws Exception { @Test public void testModifyPipelineBadRequestNoNameOrStages() throws Exception { - PipelineDTO request = new PipelineDTO(); + Pipeline request = Pipeline.newBuilder().build(); doThrow(new InvalidIdException("Request must contain either name or stages")) - .when(pipelineService).modifyPipeline(eq("pid"), any(PipelineDTO.class)); + .when(pipelineService).modifyPipeline(eq("pid"), any(Pipeline.class)); assertThrows(InvalidIdException.class, () -> controller.modifyPipeline("pid", request)); } @Test public void testModifyPipelineStagesBadRequestEmpty() throws Exception { - PipelineDTO request = new PipelineDTO(); - request.setStages(new ArrayList<>()); + Pipeline request = Pipeline.newBuilder().build(); doThrow(new InvalidIdException("Request must contain either name or stages")) - .when(pipelineService).modifyPipeline(eq("pid"), any(PipelineDTO.class)); + .when(pipelineService).modifyPipeline(eq("pid"), any(Pipeline.class)); assertThrows(InvalidIdException.class, () -> controller.modifyPipeline("pid", request)); } @Test public void testCreatePipelineWithDuplicateStages() throws Exception { - PipelineDTO dto = new PipelineDTO(); - dto.setName("pipe-x"); - dto.setStages(List.of( - new StageDTO(null, "build", "bash", "echo 1"), - new StageDTO(null, "Build", "bash", "echo 2"))); + Pipeline dto = Pipeline.newBuilder() + .setName("pipe-x") + .addAllStages(List.of( + Stage.newBuilder().setName("build").setScriptType("bash").setCommand("echo 1").build(), + Stage.newBuilder().setName("Build").setScriptType("bash").setCommand("echo 2").build())) + .build(); - // Explicitly stub it to throw the expected DuplicateEntryException. doThrow(new DuplicateEntryException("Duplicate stage name 'build'")) - .when(pipelineService).createPipeline(any(PipelineDTO.class)); + .when(pipelineService).createPipeline(any(Pipeline.class)); assertThrows(DuplicateEntryException.class, () -> controller.createPipeline(dto)); } @Test public void testCreatePipelineSuccess() throws Exception { - PipelineDTO dto = new PipelineDTO(); - dto.setName("pipe-y"); - dto.setStages(List.of(new StageDTO(null, "build", "bash", "echo 1"))); - PipelineDTO saved = new PipelineDTO(); - saved.setId(UUID.randomUUID()); - saved.setName(dto.getName()); + Pipeline dto = Pipeline.newBuilder() + .setName("pipe-y") + .addAllStages(List.of(Stage.newBuilder().setName("build").setScriptType("bash").setCommand("echo 1").build())) + .build(); + Pipeline saved = dto.toBuilder().setId(UUID.randomUUID().toString()).build(); + when(pipelineService.createPipeline(dto)).thenReturn(saved); - ResponseEntity resp = controller.createPipeline(dto); + ResponseEntity resp = controller.createPipeline(dto); assertEquals(saved.getId(), resp.getBody().getId()); } @Test public void testUpdatePipelineReturnsForbiddenWhenFlagDisabled() throws Exception { when(featureFlagService.getBooleanValue(anyString())).thenReturn(false); - PipelineDTO request = new PipelineDTO(); - request.setName("should be blocked"); + Pipeline request = Pipeline.newBuilder().setName("should be blocked").build(); - ResponseEntity response = controller.updatePipeline("pid", request); + ResponseEntity response = controller.updatePipeline("pid", request); assertEquals(HttpStatus.NOT_IMPLEMENTED, response.getStatusCode()); } @Test public void testReplacePipelineStagesCompletely() throws Exception { - PipelineDTO original = DummyData.getPipelineDTO(); - original.setStages(new ArrayList<>(List.of( - new StageDTO(UUID.randomUUID(), "build", "bash", "echo build"), - new StageDTO(UUID.randomUUID(), "test", "bash", "echo test") - ))); - - PipelineDTO replaced = new PipelineDTO(); - replaced.setId(original.getId()); - replaced.setName(original.getName()); - replaced.setStages(List.of( - new StageDTO(UUID.randomUUID(), "deploy", "bash", "echo deploy") - )); + Pipeline replaced = Pipeline.newBuilder() + .setId(UUID.randomUUID().toString()).setName(pipelineDTO.getName()) + .addAllStages(List.of(Stage.newBuilder().setId(UUID.randomUUID().toString()) + .setName("deploy").setScriptType("bash").setCommand("echo deploy").build())) + .build(); - PipelineDTO request = new PipelineDTO(); - request.setStages(List.of( - new StageDTO(null, "deploy", "bash", "echo deploy") - )); + Pipeline request = Pipeline.newBuilder() + .addAllStages(List.of(Stage.newBuilder().setName("deploy").setScriptType("bash").setCommand("echo deploy").build())) + .build(); - doReturn(replaced).when(pipelineService).replacePipeline(eq("pid"), any(PipelineDTO.class)); + doReturn(replaced).when(pipelineService).replacePipeline(eq("pid"), any(Pipeline.class)); - ResponseEntity response = controller.updatePipeline("pid", request); + ResponseEntity response = controller.updatePipeline("pid", request); assertEquals(HttpStatus.OK, response.getStatusCode()); - assertEquals(1, response.getBody().getStages().size()); - assertEquals("deploy", response.getBody().getStages().get(0).getName()); + assertEquals(1, response.getBody().getStagesList().size()); + assertEquals("deploy", response.getBody().getStagesList().get(0).getName()); } @Test public void testReplacePipelineNameAndStages() throws Exception { - PipelineDTO replaced = new PipelineDTO(); - replaced.setId(UUID.randomUUID()); - replaced.setName("NewPipelineName"); - replaced.setStages(List.of( - new StageDTO(UUID.randomUUID(), "stage1", "python", "print('hello')"), - new StageDTO(UUID.randomUUID(), "stage2", "bash", "echo 'world'") - )); + Pipeline replaced = Pipeline.newBuilder() + .setId(UUID.randomUUID().toString()).setName("NewPipelineName") + .addAllStages(List.of( + Stage.newBuilder().setId(UUID.randomUUID().toString()).setName("stage1").setScriptType("python").setCommand("print('hello')").build(), + Stage.newBuilder().setId(UUID.randomUUID().toString()).setName("stage2").setScriptType("bash").setCommand("echo 'world'").build())) + .build(); - PipelineDTO request = new PipelineDTO(); - request.setName("NewPipelineName"); - request.setStages(List.of( - new StageDTO(null, "stage1", "python", "print('hello')"), - new StageDTO(null, "stage2", "bash", "echo 'world'") - )); + Pipeline request = Pipeline.newBuilder() + .setName("NewPipelineName") + .addAllStages(List.of( + Stage.newBuilder().setName("stage1").setScriptType("python").setCommand("print('hello')").build(), + Stage.newBuilder().setName("stage2").setScriptType("bash").setCommand("echo 'world'").build())) + .build(); - doReturn(replaced).when(pipelineService).replacePipeline(eq("pid"), any(PipelineDTO.class)); + doReturn(replaced).when(pipelineService).replacePipeline(eq("pid"), any(Pipeline.class)); - ResponseEntity response = controller.updatePipeline("pid", request); + ResponseEntity response = controller.updatePipeline("pid", request); assertEquals(HttpStatus.OK, response.getStatusCode()); assertEquals("NewPipelineName", response.getBody().getName()); - assertEquals(2, response.getBody().getStages().size()); + assertEquals(2, response.getBody().getStagesList().size()); } @Test public void testReplacePipelineInvalidId() throws Exception { - PipelineDTO request = new PipelineDTO(); - request.setName("test"); + Pipeline request = Pipeline.newBuilder().setName("test").build(); doThrow(new InvalidIdException("Invalid ID")).when(pipelineService) - .replacePipeline(eq("invalid"), any(PipelineDTO.class)); + .replacePipeline(eq("invalid"), any(Pipeline.class)); assertThrows(InvalidIdException.class, () -> controller.updatePipeline("invalid", request)); } @Test public void testReplacePipelineDuplicateName() throws Exception { - PipelineDTO request = new PipelineDTO(); - request.setName("existingName"); + Pipeline request = Pipeline.newBuilder().setName("existingName").build(); doThrow(new DuplicateEntryException("Name exists")).when(pipelineService) - .replacePipeline(eq("pid"), any(PipelineDTO.class)); + .replacePipeline(eq("pid"), any(Pipeline.class)); assertThrows(DuplicateEntryException.class, () -> controller.updatePipeline("pid", request)); } -} \ No newline at end of file +} diff --git a/pipeline/src/test/java/com/autobuild/pipeline/definition/dto/PipelineResponseTest.java b/pipeline/src/test/java/com/autobuild/pipeline/definition/dto/PipelineResponseTest.java index a2a67089c..0703260c9 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/definition/dto/PipelineResponseTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/definition/dto/PipelineResponseTest.java @@ -12,8 +12,8 @@ import org.junit.jupiter.api.Test; import com.autobuild.pipeline.definiton.dto.PipelineResponse; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.definiton.entity.Stage; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.definiton.entity.StageEntity; public class PipelineResponseTest { @@ -26,7 +26,7 @@ public void testDefaultConstructor() { @Test public void testConstructorWithPipeline() { - Pipeline pipeline = new Pipeline(); + PipelineEntity pipeline = new PipelineEntity(); pipeline.setId(UUID.randomUUID()); pipeline.setName("test-pipeline"); @@ -55,21 +55,21 @@ public void testSetAndGetErrors() { @Test public void testPipelineWithStages() { - Pipeline pipeline = new Pipeline(); + PipelineEntity pipeline = new PipelineEntity(); pipeline.setId(UUID.randomUUID()); pipeline.setName("complex-pipeline"); - Stage stage1 = new Stage(); + StageEntity stage1 = new StageEntity(); stage1.setId(UUID.randomUUID()); stage1.setName("build"); stage1.setScriptType("bash"); - Stage stage2 = new Stage(); + StageEntity stage2 = new StageEntity(); stage2.setId(UUID.randomUUID()); stage2.setName("test"); stage2.setScriptType("python"); - List stages = new ArrayList<>(); + List stages = new ArrayList<>(); stages.add(stage1); stages.add(stage2); pipeline.setStages(stages); @@ -84,7 +84,7 @@ public void testPipelineWithStages() { @Test public void testResponseWithPipelineAndErrors() { - Pipeline pipeline = new Pipeline(); + PipelineEntity pipeline = new PipelineEntity(); pipeline.setId(UUID.randomUUID()); pipeline.setName("test-pipeline"); diff --git a/pipeline/src/test/java/com/autobuild/pipeline/definition/mapper/PipelineMapperTest.java b/pipeline/src/test/java/com/autobuild/pipeline/definition/mapper/PipelineMapperTest.java index 913dab3cd..b2009a518 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/definition/mapper/PipelineMapperTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/definition/mapper/PipelineMapperTest.java @@ -10,34 +10,32 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; -import com.autobuild.pipeline.configuration.MapperConfig; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; import com.autobuild.pipeline.definiton.dto.mapper.PipelineMapper; -import com.autobuild.pipeline.definiton.entity.Pipeline; +import com.autobuild.pipeline.definiton.dto.mapper.StageMapper; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; import com.autobuild.pipeline.testutility.DummyData; @SpringJUnitConfig -@ContextConfiguration(classes = {MapperConfig.class,PipelineMapper.class}) +@ContextConfiguration(classes = {PipelineMapper.class, StageMapper.class}) public class PipelineMapperTest { - private Pipeline pipeline = DummyData.getPipeline(); - private PipelineDTO pipelineDTO = DummyData.getPipelineDTO(); + private PipelineEntity pipeline = DummyData.getPipeline(); + private Pipeline pipelineDTO = DummyData.getPipelineDTO(); @Autowired private PipelineMapper pipelineMapper; @Test public void whenGivenPipelineEntityGetPipelineDTO() { - PipelineDTO convertedDto = pipelineMapper.entityToDto(pipeline); - + Pipeline convertedDto = pipelineMapper.entityToDto(pipeline); assertDto(convertedDto); } @Test public void whenGivenPipelineDTOGetPipelineEntity() { - Pipeline pipeline = pipelineMapper.dtoToEntity(pipelineDTO); - - assertEntity(pipeline); + PipelineEntity converted = pipelineMapper.dtoToEntity(pipelineDTO); + assertEntity(converted); } @Test @@ -52,28 +50,28 @@ public void whenGivenNullDTPGetPipeline() { @Test public void multipleMapInvocationTest() { - Pipeline p1 = pipelineMapper.dtoToEntity(pipelineDTO); + PipelineEntity p1 = pipelineMapper.dtoToEntity(pipelineDTO); assertEntity(p1); - pipelineDTO.setId(UUID.randomUUID()); - - Pipeline p2 = pipelineMapper.dtoToEntity(pipelineDTO); - assertEntity(p2); + Pipeline pipelineDTO2 = pipelineDTO.toBuilder().setId(UUID.randomUUID().toString()).build(); + PipelineEntity p2 = pipelineMapper.dtoToEntity(pipelineDTO2); + assertEquals(pipelineDTO2.getId(), p2.getId().toString()); + assertEquals(pipelineDTO2.getName(), p2.getName()); } - private void assertDto(PipelineDTO convertedDto) { - assertEquals(pipeline.getId(), convertedDto.getId()); + private void assertDto(Pipeline convertedDto) { + assertEquals(pipeline.getId().toString(), convertedDto.getId()); assertEquals(pipeline.getName(), convertedDto.getName()); - assertEquals(pipeline.getStages().size(),convertedDto.getStages().size()); - assertEquals(pipeline.getStages().get(0).getName(), convertedDto.getStages().get(0).getName()); - assertEquals(pipeline.getStages().get(0).getId(), convertedDto.getStages().get(0).getId()); + assertEquals(pipeline.getStages().size(), convertedDto.getStagesList().size()); + assertEquals(pipeline.getStages().get(0).getName(), convertedDto.getStagesList().get(0).getName()); + assertEquals(pipeline.getStages().get(0).getId().toString(), convertedDto.getStagesList().get(0).getId()); } - private void assertEntity(Pipeline pipeline) { - assertEquals(pipelineDTO.getName(), pipeline.getName()); - assertEquals(pipelineDTO.getId(), pipeline.getId()); - assertEquals(pipelineDTO.getStages().size(), pipeline.getStages().size()); - assertEquals(pipelineDTO.getStages().get(0).getName(), pipeline.getStages().get(0).getName()); - assertEquals(pipelineDTO.getStages().get(0).getId(), pipeline.getStages().get(0).getId()); + private void assertEntity(PipelineEntity converted) { + assertEquals(pipelineDTO.getName(), converted.getName()); + assertEquals(pipelineDTO.getId(), converted.getId().toString()); + assertEquals(pipelineDTO.getStagesList().size(), converted.getStages().size()); + assertEquals(pipelineDTO.getStagesList().get(0).getName(), converted.getStages().get(0).getName()); + assertEquals(pipelineDTO.getStagesList().get(0).getId(), converted.getStages().get(0).getId().toString()); } -} \ No newline at end of file +} diff --git a/pipeline/src/test/java/com/autobuild/pipeline/definition/mapper/StageMapperTest.java b/pipeline/src/test/java/com/autobuild/pipeline/definition/mapper/StageMapperTest.java index 38317e7d6..de5f27f10 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/definition/mapper/StageMapperTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/definition/mapper/StageMapperTest.java @@ -8,27 +8,24 @@ import org.springframework.test.context.ContextConfiguration; import org.springframework.test.context.junit.jupiter.SpringJUnitConfig; -import com.autobuild.pipeline.configuration.MapperConfig; -import com.autobuild.pipeline.definiton.dto.StageDTO; +import com.autobuild.pipeline.definiton.gen.dto.Stage; import com.autobuild.pipeline.definiton.dto.mapper.StageMapper; -import com.autobuild.pipeline.definiton.entity.Stage; +import com.autobuild.pipeline.definiton.entity.StageEntity; import com.autobuild.pipeline.testutility.DummyData; @SpringJUnitConfig -@ContextConfiguration(classes = {MapperConfig.class,StageMapper.class}) +@ContextConfiguration(classes = {StageMapper.class}) public class StageMapperTest { - - private Stage stage = DummyData.getStage(); - private StageDTO dto = DummyData.getStageDTO(); + + private StageEntity stage = DummyData.getStage(); + private Stage dto = DummyData.getStageDTO(); @Autowired private StageMapper stageMapper; @Test public void givenStageEntityGetStageDTO() { - - StageDTO convertedStageDTO = stageMapper.entityToDto(stage); - + Stage convertedStageDTO = stageMapper.entityToDto(stage); assertDto(convertedStageDTO); } @@ -39,11 +36,10 @@ public void givenNullEntityGetStageDTO() { @Test public void givenStageDTOGetStageEntity() { - Stage convertedStage = stageMapper.dtoToEntity(dto); - + StageEntity convertedStage = stageMapper.dtoToEntity(dto); assertEntity(convertedStage); } - + @Test public void givenNullDTOGetStageEntity() { assertThrows(IllegalArgumentException.class, () -> stageMapper.dtoToEntity(null)); @@ -51,21 +47,21 @@ public void givenNullDTOGetStageEntity() { @Test public void multipleMapInvocationTest() { - Stage s1 = stageMapper.dtoToEntity(dto); + StageEntity s1 = stageMapper.dtoToEntity(dto); assertEntity(s1); - Stage s2 = stageMapper.dtoToEntity(dto); + StageEntity s2 = stageMapper.dtoToEntity(dto); assertEntity(s2); } - private void assertEntity(Stage convertedStageEntity) { - assertEquals(dto.getId(), convertedStageEntity.getId()); + private void assertEntity(StageEntity convertedStageEntity) { + assertEquals(dto.getId(), convertedStageEntity.getId().toString()); assertEquals(dto.getName(), convertedStageEntity.getName()); assertEquals(dto.getScriptType(), convertedStageEntity.getScriptType()); - } + } - private void assertDto(StageDTO convertedStageDTO) { - assertEquals(stage.getId(), convertedStageDTO.getId()); + private void assertDto(Stage convertedStageDTO) { + assertEquals(stage.getId().toString(), convertedStageDTO.getId()); assertEquals(stage.getName(), convertedStageDTO.getName()); assertEquals(stage.getScriptType(), convertedStageDTO.getScriptType()); } diff --git a/pipeline/src/test/java/com/autobuild/pipeline/definition/service/PipelineServiceTest.java b/pipeline/src/test/java/com/autobuild/pipeline/definition/service/PipelineServiceTest.java index c48202be2..cedd241fe 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/definition/service/PipelineServiceTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/definition/service/PipelineServiceTest.java @@ -12,8 +12,8 @@ import java.util.ArrayList; import java.util.HashMap; - import java.util.List; +import java.util.Map; import java.util.NoSuchElementException; import java.util.Optional; import java.util.UUID; @@ -25,24 +25,26 @@ import org.mockito.Mock; import org.mockito.MockedStatic; import org.mockito.MockitoAnnotations; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.dto.StageDTO; + +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; +import com.autobuild.pipeline.definiton.gen.dto.Stage; import com.autobuild.pipeline.definiton.dto.mapper.PipelineMapper; import com.autobuild.pipeline.definiton.dto.mapper.StageMapper; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.definiton.entity.Stage; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.definiton.entity.StageEntity; import com.autobuild.pipeline.definiton.exceptions.DuplicateEntryException; import com.autobuild.pipeline.definiton.exceptions.InvalidIdException; import com.autobuild.pipeline.definiton.repository.PipelineRepository; import com.autobuild.pipeline.definiton.service.PipelineService; import com.autobuild.pipeline.testutility.DummyData; import com.autobuild.pipeline.utility.file.PipelineFileService; + import jakarta.persistence.EntityNotFoundException; public class PipelineServiceTest { - private PipelineDTO pipelineDTO = DummyData.getPipelineDTO(); - private Pipeline pipeline = DummyData.getPipeline(); + private Pipeline pipelineDTO = DummyData.getPipelineDTO(); + private PipelineEntity pipeline = DummyData.getPipeline(); @Mock private PipelineRepository repository; @@ -63,47 +65,46 @@ public class PipelineServiceTest { public void setUp() { MockitoAnnotations.openMocks(this); - // Mapper behavior to reflect pipeline changes doAnswer(inv -> { - Pipeline p = inv.getArgument(0); - PipelineDTO dto = new PipelineDTO(); - dto.setId(p.getId()); - dto.setName(p.getName()); - List stages = p.getStages().stream().map(s -> { - StageDTO sd = new StageDTO(); - sd.setId(s.getId()); - sd.setName(s.getName()); - sd.setScriptType(s.getScriptType()); - sd.setCommand(""); - return sd; - }).collect(Collectors.toList()); - dto.setStages(stages); - return dto; - }).when(mapper).entityToDto(any(Pipeline.class)); + PipelineEntity p = inv.getArgument(0); + List stages = p.getStages().stream().map(s -> + Stage.newBuilder() + .setId(s.getId().toString()) + .setName(s.getName()) + .setScriptType(s.getScriptType()) + .setCommand("") + .build() + ).collect(Collectors.toList()); + return Pipeline.newBuilder() + .setId(p.getId().toString()) + .setName(p.getName()) + .addAllStages(stages) + .build(); + }).when(mapper).entityToDto(any(PipelineEntity.class)); doAnswer(inv -> { - PipelineDTO dto = inv.getArgument(0); - Pipeline p = new Pipeline(); - p.setId(dto.getId()); + Pipeline dto = inv.getArgument(0); + PipelineEntity p = new PipelineEntity(); + if (!dto.getId().isBlank()) p.setId(UUID.fromString(dto.getId())); p.setName(dto.getName()); - p.setStages(dto.getStages().stream().map(st -> { - Stage s = new Stage(); - s.setId(st.getId()); + p.setStages(dto.getStagesList().stream().map(st -> { + StageEntity s = new StageEntity(); + if (!st.getId().isBlank()) s.setId(UUID.fromString(st.getId())); s.setName(st.getName()); s.setScriptType(st.getScriptType()); return s; }).collect(Collectors.toList())); return p; - }).when(mapper).dtoToEntity(any(PipelineDTO.class)); + }).when(mapper).dtoToEntity(any(Pipeline.class)); doAnswer(inv -> { - StageDTO sd = inv.getArgument(0); - Stage s = new Stage(); - s.setId(sd.getId()); + Stage sd = inv.getArgument(0); + StageEntity s = new StageEntity(); + if (!sd.getId().isBlank()) s.setId(UUID.fromString(sd.getId())); s.setName(sd.getName()); s.setScriptType(sd.getScriptType()); return s; - }).when(stageMapper).dtoToEntity(any(StageDTO.class)); + }).when(stageMapper).dtoToEntity(any(Stage.class)); } @Test @@ -124,19 +125,22 @@ public void testGetPipelineByIdWithInvalidId() { @Test public void testGetAllPipelines() { - List pipelines = List.of(pipeline); + List pipelines = List.of(pipeline); doReturn(pipelines).when(repository).findAll(); - List result = service.getAllPipelines(); + List result = service.getAllPipelines(); assertEquals(1, result.size()); - assertEquals(pipeline.getId(), result.get(0).getId()); + assertEquals(pipeline.getId().toString(), result.get(0).getId()); } @Test public void testGetPipelineByIdWithValidId() throws Exception { UUID id = UUID.randomUUID(); pipeline.setId(id); + Map stageContents = new HashMap<>(); + pipelineDTO.getStagesList().forEach(s -> stageContents.put(UUID.fromString(s.getId()), s.getCommand())); doReturn(Optional.of(pipeline)).when(repository).findById(id); doReturn(pipelineDTO).when(mapper).entityToDto(pipeline); + doReturn(stageContents).when(fileService).readScriptFiles(pipeline); assertEquals(pipelineDTO, service.getPipelineById(id.toString())); } @@ -154,11 +158,10 @@ public void testModifyPipelineStagesDuplicateUpdateName() throws Exception { if (pipeline.getStages().size() < 2) return; doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - Stage target = pipeline.getStages().get(0); + StageEntity target = pipeline.getStages().get(0); String otherName = pipeline.getStages().get(1).getName(); - StageDTO update = new StageDTO(target.getId(), otherName, null, null); - PipelineDTO request = new PipelineDTO(); - request.setStages(List.of(update)); + Stage update = Stage.newBuilder().setId(target.getId().toString()).setName(otherName).build(); + Pipeline request = Pipeline.newBuilder().addAllStages(List.of(update)).build(); assertThrows(DuplicateEntryException.class, () -> service.modifyPipeline(pipeline.getId().toString(), request)); } @@ -166,8 +169,7 @@ public void testModifyPipelineStagesDuplicateUpdateName() throws Exception { @Test public void testModifyPipelineStagesEmptyList() { ensurePipelineId(); - PipelineDTO request = new PipelineDTO(); - request.setStages(List.of()); + Pipeline request = Pipeline.newBuilder().build(); assertThrows(InvalidIdException.class, () -> service.modifyPipeline(pipeline.getId().toString(), request)); } @@ -180,24 +182,24 @@ private void ensurePipelineId() { @Test public void testCreatePipelineAllowsDuplicateStageNames() throws Exception { - PipelineDTO dto = new PipelineDTO(); - dto.setName("pipe-two"); - dto.setStages(List.of( - new StageDTO(null, "build", "bash", "echo build", 0), - new StageDTO(null, "Build", "bash", "echo build2", 1))); // same name case-insensitive + Pipeline dto = Pipeline.newBuilder() + .setName("pipe-two") + .addAllStages(List.of( + Stage.newBuilder().setName("build").setScriptType("bash").setCommand("echo build").setStageOrder(0).build(), + Stage.newBuilder().setName("Build").setScriptType("bash").setCommand("echo build2").setStageOrder(1).build())) + .build(); doReturn(false).when(repository).existsByName("pipe-two"); doAnswer(inv -> { - Pipeline p = inv.getArgument(0); + PipelineEntity p = inv.getArgument(0); p.setId(p.getId() == null ? UUID.randomUUID() : p.getId()); return p; - }).when(repository).save(any(Pipeline.class)); + }).when(repository).save(any(PipelineEntity.class)); doReturn(new HashMap()).when(fileService).createScriptFiles(dto); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); - PipelineDTO created = service.createPipeline(dto); - assertEquals(2, created.getStages().size()); - // both names present - List names = created.getStages().stream().map(StageDTO::getName).toList(); + Pipeline created = service.createPipeline(dto); + assertEquals(2, created.getStagesList().size()); + List names = created.getStagesList().stream().map(Stage::getName).toList(); assertEquals(true, names.contains("build")); assertEquals(true, names.contains("Build")); } @@ -207,18 +209,17 @@ public void testModifyPipelineStagesDuplicateCreateNameAllowed() throws Exceptio ensurePipelineId(); pipeline.setStages(new ArrayList<>(pipeline.getStages())); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); - doReturn("path").when(fileService).createStageScriptFile(any(Pipeline.class), any(StageDTO.class)); + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); + doReturn("path").when(fileService).createStageScriptFile(any(PipelineEntity.class), any(Stage.class)); String existingName = pipeline.getStages().get(0).getName(); - StageDTO duplicate = new StageDTO(null, existingName, "bash", "echo X"); - PipelineDTO request = new PipelineDTO(); - request.setStages(List.of(duplicate)); + Stage duplicate = Stage.newBuilder().setName(existingName).setScriptType("bash").setCommand("echo X").build(); + Pipeline request = Pipeline.newBuilder().addAllStages(List.of(duplicate)).build(); int originalSize = pipeline.getStages().size(); - PipelineDTO result = service.modifyPipeline(pipeline.getId().toString(), request); - assertEquals(originalSize + 1, result.getStages().size()); + Pipeline result = service.modifyPipeline(pipeline.getId().toString(), request); + assertEquals(originalSize + 1, result.getStagesList().size()); } @Test @@ -227,23 +228,20 @@ public void testModifyPipelineStagesDuplicateUpdateNameAllowed() throws Exceptio pipeline.setStages(new ArrayList<>(pipeline.getStages())); if (pipeline.getStages().size() < 2) return; - Stage target = pipeline.getStages().get(0); + StageEntity target = pipeline.getStages().get(0); String otherName = pipeline.getStages().get(1).getName(); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); - - StageDTO update = new StageDTO(target.getId(), otherName, null, null); - PipelineDTO request = new PipelineDTO(); - request.setStages(List.of(update)); - - PipelineDTO result = service.modifyPipeline(pipeline.getId().toString(), request); - String updatedName = result.getStages().stream() - .filter(s -> s.getId().equals(target.getId())) - .findFirst() - .orElseThrow() - .getName(); + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); + + Stage update = Stage.newBuilder().setId(target.getId().toString()).setName(otherName).build(); + Pipeline request = Pipeline.newBuilder().addAllStages(List.of(update)).build(); + + Pipeline result = service.modifyPipeline(pipeline.getId().toString(), request); + String updatedName = result.getStagesList().stream() + .filter(s -> s.getId().equals(target.getId().toString())) + .findFirst().orElseThrow().getName(); assertEquals(otherName, updatedName); } @@ -253,8 +251,7 @@ public void testModifyPipelineNameDuplicate() throws Exception { pipeline.setName("original"); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); doReturn(true).when(repository).existsByName("newName"); - PipelineDTO patch = new PipelineDTO(); - patch.setName("newName"); + Pipeline patch = Pipeline.newBuilder().setName("newName").build(); assertThrows(DuplicateEntryException.class, () -> service.modifyPipeline(pipeline.getId().toString(), patch)); } @@ -265,19 +262,18 @@ public void testModifyPipelineNameUpdateSuccess() throws Exception { pipeline.setName("oldName"); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); doReturn(false).when(repository).existsByName("updatedName"); - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); - PipelineDTO patch = new PipelineDTO(); - patch.setName("updatedName"); - PipelineDTO result = service.modifyPipeline(pipeline.getId().toString(), patch); + Pipeline patch = Pipeline.newBuilder().setName("updatedName").build(); + Pipeline result = service.modifyPipeline(pipeline.getId().toString(), patch); assertEquals("updatedName", result.getName()); } @Test public void testModifyPipelineNoNameNoStages() { ensurePipelineId(); - PipelineDTO patch = new PipelineDTO(); + Pipeline patch = Pipeline.newBuilder().build(); assertThrows(InvalidIdException.class, () -> service.modifyPipeline(pipeline.getId().toString(), patch)); } @@ -288,9 +284,8 @@ public void testModifyPipelineStageCreateMissingFields() throws Exception { pipeline.setStages(new ArrayList<>(pipeline.getStages())); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - StageDTO badCreate = new StageDTO(null, "build", null, "echo hi"); // missing scriptType - PipelineDTO patch = new PipelineDTO(); - patch.setStages(List.of(badCreate)); + Stage badCreate = Stage.newBuilder().setName("build").setCommand("echo hi").build(); + Pipeline patch = Pipeline.newBuilder().addAllStages(List.of(badCreate)).build(); assertThrows(InvalidIdException.class, () -> service.modifyPipeline(pipeline.getId().toString(), patch)); @@ -300,24 +295,19 @@ public void testModifyPipelineStageCreateMissingFields() throws Exception { public void testModifyPipelineStageUpdateNoChanges() throws Exception { ensurePipelineId(); pipeline.setStages(new ArrayList<>(pipeline.getStages())); - Stage existing = pipeline.getStages().get(0); + StageEntity existing = pipeline.getStages().get(0); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); - // Use existing name to avoid triggering delete (all nulls -> delete in - // service). - StageDTO update = new StageDTO(existing.getId(), existing.getName(), null, null); - PipelineDTO patch = new PipelineDTO(); - patch.setStages(List.of(update)); + Stage update = Stage.newBuilder().setId(existing.getId().toString()).setName(existing.getName()).build(); + Pipeline patch = Pipeline.newBuilder().addAllStages(List.of(update)).build(); - PipelineDTO result = service.modifyPipeline(pipeline.getId().toString(), patch); + Pipeline result = service.modifyPipeline(pipeline.getId().toString(), patch); assertEquals(existing.getName(), - result.getStages().stream() - .filter(s -> s.getId().equals(existing.getId())) - .findFirst() - .orElseThrow() - .getName()); + result.getStagesList().stream() + .filter(s -> s.getId().equals(existing.getId().toString())) + .findFirst().orElseThrow().getName()); } @Test @@ -326,10 +316,8 @@ public void testModifyPipelineDeleteStageNotFound() { pipeline.setStages(new ArrayList<>(pipeline.getStages())); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - // Deletion request for non-existent stage - StageDTO del = new StageDTO(UUID.randomUUID(), null, null, null); - PipelineDTO patch = new PipelineDTO(); - patch.setStages(List.of(del)); + Stage del = Stage.newBuilder().setId(UUID.randomUUID().toString()).build(); + Pipeline patch = Pipeline.newBuilder().addAllStages(List.of(del)).build(); assertThrows(InvalidIdException.class, () -> service.modifyPipeline(pipeline.getId().toString(), patch)); @@ -337,62 +325,40 @@ public void testModifyPipelineDeleteStageNotFound() { @Test public void testCreatePipelineSuccess() throws Exception { - PipelineDTO dto = new PipelineDTO(); - dto.setName("pipe-one"); - dto.setStages(List.of( - new StageDTO(null, "build", "bash", "echo build", 0), - new StageDTO(null, "test", "bash", "echo test", 1))); + Pipeline dto = Pipeline.newBuilder() + .setName("pipe-one") + .addAllStages(List.of( + Stage.newBuilder().setName("build").setScriptType("bash").setCommand("echo build").setStageOrder(0).build(), + Stage.newBuilder().setName("test").setScriptType("bash").setCommand("echo test").setStageOrder(1).build())) + .build(); doReturn(false).when(repository).existsByName("pipe-one"); doAnswer(inv -> { - Pipeline p = inv.getArgument(0); + PipelineEntity p = inv.getArgument(0); p.setId(p.getId() == null ? UUID.randomUUID() : p.getId()); return p; - }).when(repository).save(any(Pipeline.class)); + }).when(repository).save(any(PipelineEntity.class)); doReturn(new HashMap()).when(fileService).createScriptFiles(dto); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); - PipelineDTO created = service.createPipeline(dto); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); + Pipeline created = service.createPipeline(dto); assertEquals("pipe-one", created.getName()); - assertEquals(2, created.getStages().size()); + assertEquals(2, created.getStagesList().size()); } @Test public void testCreatePipelineDuplicatePipelineName() { - PipelineDTO dto = new PipelineDTO(); - dto.setName("existing"); + Pipeline dto = Pipeline.newBuilder().setName("existing").build(); doReturn(true).when(repository).existsByName("existing"); assertThrows(DuplicateEntryException.class, () -> service.createPipeline(dto)); } - @Test - public void testCreatePipelineRejectsDuplicateStageOrder() { - PipelineDTO dto = new PipelineDTO(); - dto.setName("pipe"); - dto.setStages(List.of( - new StageDTO(null, "build", "bash", "echo build", 0), - new StageDTO(null, "test", "bash", "echo test", 0))); - doReturn(false).when(repository).existsByName("pipe"); - assertThrows(DuplicateEntryException.class, () -> service.createPipeline(dto)); - } - - @Test - public void testCreatePipelineRejectsNegativeStageOrder() { - PipelineDTO dto = new PipelineDTO(); - dto.setName("pipe"); - dto.setStages(List.of( - new StageDTO(null, "build", "bash", "echo build", -1))); - doReturn(false).when(repository).existsByName("pipe"); - assertThrows(InvalidIdException.class, () -> service.createPipeline(dto)); - } - @Test public void testDeletePipelineSuccess() throws Exception { ensurePipelineId(); pipeline.setStages(new ArrayList<>(pipeline.getStages())); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doNothing().when(repository).delete(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService) - .createScriptFiles(any(PipelineDTO.class)); - doNothing().when(fileService).removeScriptFiles(any(PipelineDTO.class)); + doNothing().when(repository).delete(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).createScriptFiles(any(Pipeline.class)); + doNothing().when(fileService).removeScriptFiles(any(Pipeline.class)); service.deletePipelineById(pipeline.getId().toString()); verify(repository).delete(pipeline); } @@ -408,102 +374,99 @@ public void testDeletePipelineNotFound() { public void testModifyPipelineStageDeleteSuccess() throws Exception { ensurePipelineId(); pipeline.setStages(new ArrayList<>(pipeline.getStages())); - Stage toDelete = pipeline.getStages().get(0); + StageEntity toDelete = pipeline.getStages().get(0); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doNothing().when(fileService).removeStageScriptFile(any(Stage.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doNothing().when(fileService).removeStageScriptFile(any(StageEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); - // Delete by providing only the ID (all other fields null). - StageDTO del = new StageDTO(toDelete.getId(), null, null, null); - PipelineDTO patch = new PipelineDTO(); - patch.setStages(List.of(del)); + Stage del = Stage.newBuilder().setId(toDelete.getId().toString()).build(); + Pipeline patch = Pipeline.newBuilder().addAllStages(List.of(del)).build(); - PipelineDTO result = service.modifyPipeline(pipeline.getId().toString(), patch); + Pipeline result = service.modifyPipeline(pipeline.getId().toString(), patch); assertThrows(NoSuchElementException.class, - () -> result.getStages().stream() - .filter(s -> s.getId().equals(toDelete.getId())) - .findFirst() - .orElseThrow()); + () -> result.getStagesList().stream() + .filter(s -> s.getId().equals(toDelete.getId().toString())) + .findFirst().orElseThrow()); } @Test public void testModifyPipelineMixedOperations() throws Exception { ensurePipelineId(); pipeline.setStages(new ArrayList<>(pipeline.getStages())); - Stage existing = pipeline.getStages().get(0); + StageEntity existing = pipeline.getStages().get(0); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); - doNothing().when(fileService).updateStageScriptFile(any(Stage.class), anyString()); - doReturn("path").when(fileService).createStageScriptFile(any(Pipeline.class), any(StageDTO.class)); - StageDTO create = new StageDTO(null, "deploy", "bash", "echo deploy"); - StageDTO updateNameAndScript = new StageDTO(existing.getId(), "renamed", null, "echo changed"); - PipelineDTO patch = new PipelineDTO(); - patch.setStages(List.of(create, updateNameAndScript)); - PipelineDTO result = service.modifyPipeline(pipeline.getId().toString(), patch); - assertEquals(pipeline.getStages().size(), result.getStages().size()); + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); + doNothing().when(fileService).updateStageScriptFile(any(StageEntity.class), anyString()); + doReturn("path").when(fileService).createStageScriptFile(any(PipelineEntity.class), any(Stage.class)); + Stage create = Stage.newBuilder().setName("deploy").setScriptType("bash").setCommand("echo deploy").build(); + Stage updateStage = Stage.newBuilder().setId(existing.getId().toString()).setName("renamed").setCommand("echo changed").build(); + Pipeline patch = Pipeline.newBuilder().addAllStages(List.of(create, updateStage)).build(); + Pipeline result = service.modifyPipeline(pipeline.getId().toString(), patch); + assertEquals(pipeline.getStages().size(), result.getStagesList().size()); assertEquals("renamed", - result.getStages().stream().filter(s -> s.getId().equals(existing.getId())).findFirst().orElseThrow() - .getName()); + result.getStagesList().stream() + .filter(s -> s.getId().equals(existing.getId().toString())) + .findFirst().orElseThrow().getName()); } @Test public void testModifyPipelineStageUpdateScriptOnly() throws Exception { ensurePipelineId(); pipeline.setStages(new ArrayList<>(pipeline.getStages())); - Stage existing = pipeline.getStages().get(0); + StageEntity existing = pipeline.getStages().get(0); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); - doNothing().when(fileService).updateStageScriptFile(any(Stage.class), anyString()); - // scriptType must be null (updates are forbidden) - StageDTO update = new StageDTO(existing.getId(), existing.getName(), null, "echo new"); - PipelineDTO patch = new PipelineDTO(); - patch.setStages(List.of(update)); - PipelineDTO result = service.modifyPipeline(pipeline.getId().toString(), patch); + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); + doNothing().when(fileService).updateStageScriptFile(any(StageEntity.class), anyString()); + Stage update = Stage.newBuilder().setId(existing.getId().toString()).setName(existing.getName()).setCommand("echo new").build(); + Pipeline patch = Pipeline.newBuilder().addAllStages(List.of(update)).build(); + Pipeline result = service.modifyPipeline(pipeline.getId().toString(), patch); assertEquals(existing.getName(), - result.getStages().stream().filter(s -> s.getId().equals(existing.getId())).findFirst().orElseThrow() - .getName()); + result.getStagesList().stream() + .filter(s -> s.getId().equals(existing.getId().toString())) + .findFirst().orElseThrow().getName()); } @Test public void testReplacePipelineStagesCompletely() throws Exception { ensurePipelineId(); - pipeline.setName("existing-name"); // Add this line + pipeline.setName("existing-name"); pipeline.setStages(new ArrayList<>(List.of( createStage("build", "bash"), createStage("test", "bash") ))); - + doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doReturn(false).when(repository).existsByName("existing-name"); // Add this line - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); - doReturn("path").when(fileService).createStageScriptFile(any(Pipeline.class), any(StageDTO.class)); - doNothing().when(fileService).removeStageScriptFile(any(Stage.class)); + doReturn(false).when(repository).existsByName("existing-name"); + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); + doReturn("path").when(fileService).createStageScriptFile(any(PipelineEntity.class), any(Stage.class)); + doNothing().when(fileService).removeStageScriptFile(any(StageEntity.class)); - PipelineDTO request = new PipelineDTO(); - request.setName("existing-name"); // Add this line - PUT requires name - request.setStages(List.of(new StageDTO(null, "deploy", "bash", "echo deploy"))); + Pipeline request = Pipeline.newBuilder() + .setName("existing-name") + .addAllStages(List.of(Stage.newBuilder().setName("deploy").setScriptType("bash").setCommand("echo deploy").build())) + .build(); - PipelineDTO result = service.replacePipeline(pipeline.getId().toString(), request); - - assertEquals(1, result.getStages().size()); - assertEquals("deploy", result.getStages().get(0).getName()); + Pipeline result = service.replacePipeline(pipeline.getId().toString(), request); + assertEquals(1, result.getStagesList().size()); + assertEquals("deploy", result.getStagesList().get(0).getName()); } @Test public void testReplacePipelineMissingScriptType() throws Exception { ensurePipelineId(); - pipeline.setName("test-pipeline"); // Add this line + pipeline.setName("test-pipeline"); pipeline.setStages(new ArrayList<>()); doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); - doReturn(false).when(repository).existsByName("test-pipeline"); // Add this line + doReturn(false).when(repository).existsByName("test-pipeline"); - PipelineDTO request = new PipelineDTO(); - request.setName("test-pipeline"); // Add this line - PUT requires name - request.setStages(List.of(new StageDTO(null, "stage", null, "echo test"))); + Pipeline request = Pipeline.newBuilder() + .setName("test-pipeline") + .addAllStages(List.of(Stage.newBuilder().setName("stage").setCommand("echo test").build())) + .build(); assertThrows(InvalidIdException.class, () -> service.replacePipeline(pipeline.getId().toString(), request)); @@ -514,24 +477,22 @@ public void testReplacePipelineNameAndStages() throws Exception { ensurePipelineId(); pipeline.setName("oldName"); pipeline.setStages(new ArrayList<>(List.of(createStage("old", "bash")))); - + doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); doReturn(false).when(repository).existsByName("newName"); - doReturn(pipeline).when(repository).save(any(Pipeline.class)); - doReturn(new HashMap()).when(fileService).readScriptFiles(any(Pipeline.class)); - doReturn("path").when(fileService).createStageScriptFile(any(Pipeline.class), any(StageDTO.class)); - doNothing().when(fileService).removeStageScriptFile(any(Stage.class)); - - PipelineDTO request = new PipelineDTO(); - request.setName("newName"); - request.setStages(List.of( - new StageDTO(null, "stage2", "bash", "echo world") - )); - - PipelineDTO result = service.replacePipeline(pipeline.getId().toString(), request); - + doReturn(pipeline).when(repository).save(any(PipelineEntity.class)); + doReturn(new HashMap()).when(fileService).readScriptFiles(any(PipelineEntity.class)); + doReturn("path").when(fileService).createStageScriptFile(any(PipelineEntity.class), any(Stage.class)); + doNothing().when(fileService).removeStageScriptFile(any(StageEntity.class)); + + Pipeline request = Pipeline.newBuilder() + .setName("newName") + .addAllStages(List.of(Stage.newBuilder().setName("stage2").setScriptType("bash").setCommand("echo world").build())) + .build(); + + Pipeline result = service.replacePipeline(pipeline.getId().toString(), request); assertEquals("newName", result.getName()); - assertEquals(1, result.getStages().size()); + assertEquals(1, result.getStagesList().size()); } @Test @@ -541,17 +502,41 @@ public void testReplacePipelineDuplicateName() throws Exception { doReturn(Optional.of(pipeline)).when(repository).findById(pipeline.getId()); doReturn(true).when(repository).existsByName("existingName"); - PipelineDTO request = new PipelineDTO(); - request.setName("existingName"); + Pipeline request = Pipeline.newBuilder().setName("existingName").build(); assertThrows(DuplicateEntryException.class, () -> service.replacePipeline(pipeline.getId().toString(), request)); } - private Stage createStage(String name, String scriptType) { - Stage stage = new Stage(); + + private StageEntity createStage(String name, String scriptType) { + StageEntity stage = new StageEntity(); stage.setId(UUID.randomUUID()); stage.setName(name); stage.setScriptType(scriptType); return stage; } + + @Test + public void testCreatePipelineRejectsNegativeStageOrder() { + Pipeline dto = Pipeline.newBuilder() + .setName("bad-pipe") + .addAllStages(List.of( + Stage.newBuilder().setName("first").setScriptType("bash").setCommand("echo 1").setStageOrder(0).build(), + Stage.newBuilder().setName("second").setScriptType("bash").setCommand("echo 2").setStageOrder(-1).build())) + .build(); + doReturn(false).when(repository).existsByName("bad-pipe"); + assertThrows(InvalidIdException.class, () -> service.createPipeline(dto)); + } + + @Test + public void testCreatePipelineRejectsDuplicateStageOrder() { + Pipeline dto = Pipeline.newBuilder() + .setName("dup-pipe") + .addAllStages(List.of( + Stage.newBuilder().setName("first").setScriptType("bash").setCommand("echo 1").setStageOrder(0).build(), + Stage.newBuilder().setName("second").setScriptType("bash").setCommand("echo 2").setStageOrder(0).build())) + .build(); + doReturn(false).when(repository).existsByName("dup-pipe"); + assertThrows(DuplicateEntryException.class, () -> service.createPipeline(dto)); + } } diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/controller/PipelineBuildControllerTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/controller/PipelineBuildControllerTest.java index 2635f4a0f..c62c6a5ec 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/controller/PipelineBuildControllerTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/controller/PipelineBuildControllerTest.java @@ -21,8 +21,8 @@ import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; +import com.autobuild.pipeline.executor.gen.dto.PipelineExecutionState; import com.autobuild.pipeline.executor.service.PipelineBuildService; import com.autobuild.pipeline.testutility.DummyData; @@ -44,19 +44,22 @@ public void setup() { public void getPipelineBuildTest() { UUID pipelineBuildId = UUID.randomUUID(); - PipelineBuildDTO dummyPipelineDTO = new PipelineBuildDTO(pipelineBuildId, UUID.randomUUID(), "Dummy Pipeline", - PipelineExecutionState.WAITING, null, List.of(DummyData.getStageBuildDTO())); + PipelineBuild dummyPipelineBuild = PipelineBuild.newBuilder() + .setId(pipelineBuildId.toString()) + .setPipelineId(UUID.randomUUID().toString()) + .setPipelineName("Dummy Pipeline") + .setCurrentState(PipelineExecutionState.PIPELINE_WAITING) + .addAllStageBuilds(List.of(DummyData.getStageBuildDTO())) + .build(); - doReturn(dummyPipelineDTO).when(service).getPipelineBuild(pipelineBuildId); + doReturn(dummyPipelineBuild).when(service).getPipelineBuild(pipelineBuildId); - ResponseEntity response = controller.getPipelineBuild(pipelineBuildId); + ResponseEntity response = controller.getPipelineBuild(pipelineBuildId); assertNotNull(response); assertEquals(HttpStatus.OK, response.getStatusCode()); assertNotNull(response.getBody()); - - assertEquals(pipelineBuildId, response.getBody().getId()); - assertEquals(pipelineBuildId, response.getBody().getId()); + assertEquals(pipelineBuildId.toString(), response.getBody().getId()); } @Test @@ -68,13 +71,26 @@ public void getPipelineBuildWithInvalidUUIDTest() { @Test public void getAllBuildsTest() { - List dummyBuilds = List.of( - new PipelineBuildDTO(UUID.randomUUID(), UUID.randomUUID(), "Dummy Pipeline", PipelineExecutionState.WAITING, - null, List.of(DummyData.getStageBuildDTO())), - new PipelineBuildDTO(UUID.randomUUID(), UUID.randomUUID(), "Dummy Pipeline", PipelineExecutionState.SUCCESS, - null, List.of(DummyData.getStageBuildDTO()))); + List dummyBuilds = List.of( + PipelineBuild.newBuilder() + .setId(UUID.randomUUID().toString()) + .setPipelineId(UUID.randomUUID().toString()) + .setPipelineName("Dummy Pipeline") + .setCurrentState(PipelineExecutionState.PIPELINE_WAITING) + .addAllStageBuilds(List.of(DummyData.getStageBuildDTO())) + .build(), + PipelineBuild.newBuilder() + .setId(UUID.randomUUID().toString()) + .setPipelineId(UUID.randomUUID().toString()) + .setPipelineName("Dummy Pipeline") + .setCurrentState(PipelineExecutionState.PIPELINE_SUCCESS) + .addAllStageBuilds(List.of(DummyData.getStageBuildDTO())) + .build()); + doReturn(dummyBuilds).when(service).getAllBuilds(); - ResponseEntity> response = controller.getAllBuilds(); + + ResponseEntity> response = controller.getAllBuilds(); + assertNotNull(response); assertEquals(HttpStatus.OK, response.getStatusCode()); assertNotNull(response.getBody()); 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 100339b4e..3282899d3 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 @@ -18,7 +18,7 @@ import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; import com.autobuild.pipeline.executor.dto.PipelineExecuteRequest; import com.autobuild.pipeline.executor.service.PipelineExecutorService; import com.autobuild.pipeline.testutility.DummyData; @@ -31,35 +31,34 @@ public class PipelineExecutorControllerTest { private PipelineExecutorController controller; private PipelineExecuteRequest executeRequest = DummyData.getPipelineRequest(); - private PipelineBuildDTO pipelineBuildDTO = DummyData.getPipelineBuildDTO(executeRequest.getPipelineId()); + private PipelineBuild pipelineBuild = DummyData.getPipelineBuildDTO(executeRequest.getPipelineId()); @BeforeEach public void setUp() throws IOException { MockitoAnnotations.openMocks(this); - doReturn(pipelineBuildDTO).when(service).executePipeline(executeRequest); + doReturn(pipelineBuild).when(service).executePipeline(executeRequest); } @Test public void testExecutePipeline() throws IOException { - ResponseEntity response = controller.executePipeline(executeRequest); - + ResponseEntity response = controller.executePipeline(executeRequest); + assertNotNull(response); assertEquals(HttpStatus.ACCEPTED, response.getStatusCode()); - PipelineBuildDTO responseDto = response.getBody(); + PipelineBuild responseDto = response.getBody(); assertNotNull(responseDto); - assertEquals(executeRequest.getPipelineId(), responseDto.getPipelineId()); + assertEquals(executeRequest.getPipelineId().toString(), responseDto.getPipelineId()); - assertNotNull(responseDto.getStageBuilds()); - assertTrue(responseDto.getStageBuilds().size() > 0); + assertTrue(responseDto.getStageBuildsList().size() > 0); } @Test public void testExecutePipelineRuntimeError() throws IOException { 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/dto/mapper/PipelineBuildMapperTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/dto/mapper/PipelineBuildMapperTest.java index 45dc5a6e7..05859e853 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/dto/mapper/PipelineBuildMapperTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/dto/mapper/PipelineBuildMapperTest.java @@ -1,58 +1,50 @@ package com.autobuild.pipeline.executor.dto.mapper; 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.times; import static org.mockito.Mockito.verify; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import org.mockito.ArgumentCaptor; import org.mockito.InjectMocks; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import org.modelmapper.ModelMapper; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; +import com.autobuild.pipeline.executor.gen.dto.StageBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; import com.autobuild.pipeline.testutility.DummyData; public class PipelineBuildMapperTest { + @Mock - private ModelMapper mapper; + private StageBuildMapper stageBuildMapper; @InjectMocks private PipelineBuildMapper pipelineBuildMapper; - - private ArgumentCaptor pipelineBuildCaptor; - @BeforeEach public void setup() { MockitoAnnotations.openMocks(this); - - pipelineBuildCaptor = ArgumentCaptor.forClass(PipelineBuild.class); } @Test public void entityToDtoTest() { - PipelineBuild dummyBuild = DummyData.getPipelineBuild(); - PipelineBuildDTO dummyBuildDTO = DummyData.getPipelineBuildDTO(); - - doReturn(dummyBuildDTO).when(mapper).map(any(PipelineBuild.class), eq(PipelineBuildDTO.class)); - - PipelineBuildDTO mappedDto = pipelineBuildMapper.entityToDto(dummyBuild); + PipelineBuildEntity dummyBuild = DummyData.getPipelineBuild(); + StageBuild dummyStageBuild = DummyData.getStageBuildDTO(); - assertEquals(dummyBuildDTO, mappedDto); + doReturn(dummyStageBuild).when(stageBuildMapper).entityToDto(any(StageBuildEntity.class)); - verify(mapper, times(1)).map(pipelineBuildCaptor.capture(), eq(PipelineBuildDTO.class)); + PipelineBuild result = pipelineBuildMapper.entityToDto(dummyBuild); - assertNotNull(pipelineBuildCaptor.getValue()); - assertEquals(dummyBuild, pipelineBuildCaptor.getValue()); + assertEquals(dummyBuild.getId().toString(), result.getId()); + assertEquals(dummyBuild.getPipeline().getId().toString(), result.getPipelineId()); + assertEquals(dummyBuild.getPipeline().getName(), result.getPipelineName()); + verify(stageBuildMapper, times(dummyBuild.getStageBuilds().size())).entityToDto(any(StageBuildEntity.class)); } @Test diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/dto/mapper/StageBuildMapperTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/dto/mapper/StageBuildMapperTest.java index ada61aa07..2fbdabd39 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/dto/mapper/StageBuildMapperTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/dto/mapper/StageBuildMapperTest.java @@ -1,62 +1,40 @@ package com.autobuild.pipeline.executor.dto.mapper; 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.times; -import static org.mockito.Mockito.verify; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import org.mockito.ArgumentCaptor; import org.mockito.InjectMocks; -import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import org.modelmapper.ModelMapper; -import com.autobuild.pipeline.executor.dto.StageBuildDTO; -import com.autobuild.pipeline.executor.entity.StageBuild; +import com.autobuild.pipeline.executor.gen.dto.StageBuild; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; import com.autobuild.pipeline.testutility.DummyData; public class StageBuildMapperTest { - @Mock - private ModelMapper mapper; @InjectMocks - private StageBuildMapper StageBuildMapper; - - - private ArgumentCaptor StageBuildCaptor; + private StageBuildMapper stageBuildMapper; @BeforeEach public void setup() { MockitoAnnotations.openMocks(this); - - StageBuildCaptor = ArgumentCaptor.forClass(StageBuild.class); } @Test public void entityToDtoTest() { - StageBuild dummyBuild = DummyData.getStageBuild(); - StageBuildDTO dummyBuildDTO = DummyData.getStageBuildDTO(); - - doReturn(dummyBuildDTO).when(mapper).map(any(StageBuild.class), eq(StageBuildDTO.class)); - - StageBuildDTO mappedDto = StageBuildMapper.entityToDto(dummyBuild); - - assertEquals(dummyBuildDTO, mappedDto); + StageBuildEntity dummyBuild = DummyData.getStageBuild(); - verify(mapper, times(1)).map(StageBuildCaptor.capture(), eq(StageBuildDTO.class)); + StageBuild result = stageBuildMapper.entityToDto(dummyBuild); - assertNotNull(StageBuildCaptor.getValue()); - assertEquals(dummyBuild, StageBuildCaptor.getValue()); + assertEquals(dummyBuild.getId().toString(), result.getId()); + assertEquals(dummyBuild.getStage().getId().toString(), result.getStageId()); + assertEquals(dummyBuild.getStage().getName(), result.getStageName()); } @Test public void entityToDtoErrorTest() { - assertThrows(IllegalArgumentException.class, () -> StageBuildMapper.entityToDto(null)); + assertThrows(IllegalArgumentException.class, () -> stageBuildMapper.entityToDto(null)); } -} \ No newline at end of file +} diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/execution/observer/impl/PipelineExecutionObservableImplTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/execution/observer/impl/PipelineExecutionObservableImplTest.java index b1b20cdc3..ea4de3ae3 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/execution/observer/impl/PipelineExecutionObservableImplTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/execution/observer/impl/PipelineExecutionObservableImplTest.java @@ -16,7 +16,7 @@ import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObservable; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObserver; import com.autobuild.pipeline.testutility.DummyData; @@ -24,7 +24,7 @@ public class PipelineExecutionObservableImplTest { private PipelineExecutionObservable pipelineExecutionObservable; - private PipelineBuild dummyBuild = DummyData.getPipelineBuild(); + private PipelineBuildEntity dummyBuild = DummyData.getPipelineBuild(); @BeforeEach public void setup() { diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/job/impl/PipelineExecutorImplTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/job/impl/PipelineExecutorImplTest.java index 26383f31e..3eff505c8 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/job/impl/PipelineExecutorImplTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/job/impl/PipelineExecutorImplTest.java @@ -18,22 +18,23 @@ import org.mockito.MockedConstruction; import org.mockito.MockitoAnnotations; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObservable; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; -import com.autobuild.pipeline.executor.execution.state.StageExecutionState; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; +import com.autobuild.pipeline.executor.execution.state.StageEntityExecutionState; import com.autobuild.pipeline.executor.job.PipelineExecutor; import com.autobuild.pipeline.testutility.DummyData; public class PipelineExecutorImplTest { + @Mock private PipelineExecutionObservable pipelineExecutionObservable; @InjectMocks private PipelineExecutor pipelineExecutor = new PipelineExecutorImpl(); - private PipelineBuild pipelineBuild = DummyData.getPipelineBuild(); - + private PipelineBuildEntity pipelineBuild = DummyData.getPipelineBuild(); + @BeforeEach public void setup() { MockitoAnnotations.openMocks(this); @@ -53,8 +54,8 @@ public void executePipelineSuccessTest() throws InterruptedException { verify(mockProcessBuilderInstance, times(1)).redirectOutput(any(Redirect.class)); verify(mockProcessBuilderInstance, times(1)).redirectErrorStream(true); - - assertTrue(pipelineBuild.getCurrentState().equals(PipelineExecutionState.SUCCESS) && pipelineBuild.getStageBuilds().stream().filter(stageBuild -> !stageBuild.getCurrentState().equals(StageExecutionState.SUCCESS)).toList().size() == 0); + + assertTrue(pipelineBuild.getCurrentState().equals(PipelineEntityExecutionState.SUCCESS) && pipelineBuild.getStageBuilds().stream().filter(stageBuild -> !stageBuild.getCurrentState().equals(StageEntityExecutionState.SUCCESS)).toList().size() == 0); } } @@ -72,8 +73,8 @@ public void executePipelineFailureTest() throws InterruptedException { verify(mockProcessBuilderInstance, times(1)).redirectOutput(any(Redirect.class)); verify(mockProcessBuilderInstance, times(1)).redirectErrorStream(true); - - assertFalse(pipelineBuild.getCurrentState().equals(PipelineExecutionState.SUCCESS) && pipelineBuild.getStageBuilds().stream().filter(stageBuild -> !stageBuild.getCurrentState().equals(StageExecutionState.SUCCESS)).toList().size() == 0); + + assertFalse(pipelineBuild.getCurrentState().equals(PipelineEntityExecutionState.SUCCESS) && pipelineBuild.getStageBuilds().stream().filter(stageBuild -> !stageBuild.getCurrentState().equals(StageEntityExecutionState.SUCCESS)).toList().size() == 0); } } diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildContinuousUpdatorServiceTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildContinuousUpdatorServiceTest.java index e6d284433..0ef0d1bba 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildContinuousUpdatorServiceTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildContinuousUpdatorServiceTest.java @@ -16,7 +16,7 @@ import org.mockito.Mock; import org.mockito.MockitoAnnotations; import org.springframework.test.util.ReflectionTestUtils; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObservable; import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; import com.autobuild.pipeline.testutility.DummyData; @@ -33,7 +33,7 @@ public class PipelineBuildContinuousUpdatorServiceTest { @InjectMocks private PipelineBuildContinuousUpdatorService pipelineBuildContinuousUpdatorService; - private PipelineBuild dummyBuild = DummyData.getPipelineBuild(); + private PipelineBuildEntity dummyBuild = DummyData.getPipelineBuild(); @BeforeEach public void setup() { diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildLiveServiceTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildLiveServiceTest.java index ca7e81c1b..a9a06eee2 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildLiveServiceTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildLiveServiceTest.java @@ -21,15 +21,16 @@ import org.springframework.web.servlet.mvc.method.annotation.SseEmitter.SseEventBuilder; import com.autobuild.pipeline.executor.dto.mapper.PipelineBuildMapper; -import com.autobuild.pipeline.executor.entity.PipelineBuild; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; import com.autobuild.pipeline.executor.execution.observer.PipelineExecutionObservable; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; import com.autobuild.pipeline.testutility.DummyData; import jakarta.persistence.EntityNotFoundException; public class PipelineBuildLiveServiceTest { + @Mock private PipelineBuildRepository repository; @@ -51,9 +52,9 @@ public void setup() { public void addSubscriberTest() { UUID pipelineId = UUID.randomUUID(); - PipelineBuild pipelineBuild = DummyData.getPipelineBuild(); + PipelineBuildEntity pipelineBuild = DummyData.getPipelineBuild(); pipelineBuild.setId(pipelineId); - pipelineBuild.setCurrentState(PipelineExecutionState.RUNNING); + pipelineBuild.setCurrentState(PipelineEntityExecutionState.RUNNING); doReturn(Optional.of(pipelineBuild)).when(repository).findById(pipelineId); @@ -70,7 +71,7 @@ public void addSubscriberTest() { public void addSubscriberNotRunningPipelineTest() { UUID pipelineId = UUID.randomUUID(); - PipelineBuild pipelineBuild = DummyData.getPipelineBuild(); + PipelineBuildEntity pipelineBuild = DummyData.getPipelineBuild(); pipelineBuild.setId(pipelineId); // pipelineBuild.setCurrentState(PipelineExecutionState.RUNNING); @@ -99,9 +100,9 @@ public void addSubscriberNoPipelineTest() { public void updateTest() throws IOException { UUID pipelineId = UUID.randomUUID(); - PipelineBuild pipelineBuild = DummyData.getPipelineBuild(); + PipelineBuildEntity pipelineBuild = DummyData.getPipelineBuild(); pipelineBuild.setId(pipelineId); - pipelineBuild.setCurrentState(PipelineExecutionState.RUNNING); + pipelineBuild.setCurrentState(PipelineEntityExecutionState.RUNNING); doReturn(Optional.of(pipelineBuild)).when(repository).findById(pipelineId); @@ -118,9 +119,9 @@ public void updateTest() throws IOException { public void sentHeartBeatTest() throws IOException { UUID pipelineId = UUID.randomUUID(); - PipelineBuild pipelineBuild = DummyData.getPipelineBuild(); + PipelineBuildEntity pipelineBuild = DummyData.getPipelineBuild(); pipelineBuild.setId(pipelineId); - pipelineBuild.setCurrentState(PipelineExecutionState.RUNNING); + pipelineBuild.setCurrentState(PipelineEntityExecutionState.RUNNING); doReturn(Optional.of(pipelineBuild)).when(repository).findById(pipelineId); @@ -132,4 +133,4 @@ public void sentHeartBeatTest() throws IOException { verify(newSubscriber, times(1)).send(any(SseEventBuilder.class)); } -} \ No newline at end of file +} diff --git a/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildServiceTest.java b/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildServiceTest.java index 3d34c37ac..58deed361 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildServiceTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/executor/service/PipelineBuildServiceTest.java @@ -19,13 +19,14 @@ import org.mockito.MockitoAnnotations; import com.autobuild.pipeline.executor.dto.mapper.PipelineBuildMapper; -import com.autobuild.pipeline.executor.entity.PipelineBuild; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; import com.autobuild.pipeline.testutility.DummyData; import com.autobuild.pipeline.utility.file.PipelineFileService; public class PipelineBuildServiceTest { + @Mock private PipelineBuildRepository repository; @@ -47,8 +48,8 @@ public void setup() { public void deletePipelineBuildTest() throws IOException { UUID buildId = UUID.randomUUID(); - PipelineBuild pipelineBuild = DummyData.getPipelineBuild(buildId); - pipelineBuild.setCurrentState(PipelineExecutionState.SUCCESS); + PipelineBuildEntity pipelineBuild = DummyData.getPipelineBuild(buildId); + pipelineBuild.setCurrentState(PipelineEntityExecutionState.SUCCESS); doReturn(Optional.of(pipelineBuild)).when(repository).findById(any(UUID.class)); pipelineBuildService.deletePipelineBuild(buildId); @@ -62,12 +63,12 @@ public void deletePipelineBuildTest() throws IOException { public void deletePipelineBuildIllegalStateTest() throws IOException { UUID buildId = UUID.randomUUID(); - PipelineBuild pipelineBuild = DummyData.getPipelineBuild(buildId); + PipelineBuildEntity pipelineBuild = DummyData.getPipelineBuild(buildId); doReturn(Optional.of(pipelineBuild)).when(repository).findById(any(UUID.class)); assertThrows(IllegalStateException.class, () -> pipelineBuildService.deletePipelineBuild(buildId)); - pipelineBuild.setCurrentState(PipelineExecutionState.WAITING); + pipelineBuild.setCurrentState(PipelineEntityExecutionState.WAITING); assertThrows(IllegalStateException.class, () -> pipelineBuildService.deletePipelineBuild(buildId)); } @@ -79,6 +80,6 @@ public void getAllBuildsTest() { pipelineBuildService.getAllBuilds(); - verify(mapper, times(2)).entityToDto(any(PipelineBuild.class)); + verify(mapper, times(2)).entityToDto(any(PipelineBuildEntity.class)); } } 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 ef00bba1d..b007adb8e 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 @@ -20,12 +20,12 @@ import org.mockito.MockitoAnnotations; import org.springframework.transaction.support.TransactionSynchronizationManager; -import com.autobuild.pipeline.definiton.entity.Pipeline; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; import com.autobuild.pipeline.definiton.repository.PipelineRepository; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; 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.PipelineBuildEntity; import com.autobuild.pipeline.executor.job.PipelineExecutor; import com.autobuild.pipeline.executor.repository.PipelineBuildRepository; import com.autobuild.pipeline.testutility.DummyData; @@ -51,8 +51,6 @@ public class PipelineExecutorServiceTest { @InjectMocks private PipelineExecutorService pipelineExecutorService; - private PipelineBuildDTO pipelineBuildDTO = DummyData.getPipelineBuildDTO(); - @BeforeEach public void setup() { MockitoAnnotations.openMocks(this); @@ -62,24 +60,24 @@ public void setup() { public void executePipelineTest() throws IOException { UUID pipelineId = UUID.randomUUID(); - Pipeline pipeline = DummyData.getPipeline(pipelineId); + PipelineEntity pipeline = DummyData.getPipeline(pipelineId); PipelineExecuteRequest pipelineExecuteRequest = new PipelineExecuteRequest(pipelineId); - PipelineBuild pipelineBuild = DummyData.getPipelineBuild(pipelineId); - PipelineBuildDTO pipelineBuildDTO = DummyData.getPipelineBuildDTO(pipelineId); + PipelineBuildEntity pipelineBuild = DummyData.getPipelineBuild(pipelineId); + PipelineBuild pipelineBuildDTO = DummyData.getPipelineBuildDTO(pipelineId); doReturn(Optional.of(pipeline)).when(pipelineRepository).findById(any(UUID.class)); - doReturn(pipelineBuild).when(pipelineBuildRepository).save(any(PipelineBuild.class)); + doReturn(pipelineBuild).when(pipelineBuildRepository).save(any(PipelineBuildEntity.class)); doReturn(pipelineBuildDTO).when(pipelineBuildMapper).entityToDto(pipelineBuild); try (MockedStatic transactionSynMockedStatic = mockStatic( TransactionSynchronizationManager.class)) { - PipelineBuildDTO resultantDTO = pipelineExecutorService.executePipeline(pipelineExecuteRequest); + PipelineBuild resultantDTO = pipelineExecutorService.executePipeline(pipelineExecuteRequest); - assertEquals(pipelineExecuteRequest.getPipelineId(), resultantDTO.getPipelineId()); + assertEquals(pipelineExecuteRequest.getPipelineId().toString(), resultantDTO.getPipelineId()); verify(pipelineRepository, times(1)).findById(eq(pipelineId)); - verify(pipelineBuildRepository, times(1)).save(any(PipelineBuild.class)); + verify(pipelineBuildRepository, times(1)).save(any(PipelineBuildEntity.class)); } } 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 990e30a9f..87bbb9fa3 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/testutility/DummyData.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/testutility/DummyData.java @@ -4,39 +4,50 @@ import java.util.List; import java.util.UUID; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.dto.StageDTO; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.definiton.entity.Stage; -import com.autobuild.pipeline.executor.dto.PipelineBuildDTO; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; +import com.autobuild.pipeline.definiton.gen.dto.Stage; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.definiton.entity.StageEntity; +import com.autobuild.pipeline.executor.gen.dto.PipelineBuild; +import com.autobuild.pipeline.executor.gen.dto.StageBuild; import com.autobuild.pipeline.executor.dto.PipelineExecuteRequest; -import com.autobuild.pipeline.executor.dto.StageBuildDTO; -import com.autobuild.pipeline.executor.entity.PipelineBuild; -import com.autobuild.pipeline.executor.entity.StageBuild; -import com.autobuild.pipeline.executor.execution.state.PipelineExecutionState; -import com.autobuild.pipeline.executor.execution.state.StageExecutionState; +import com.autobuild.pipeline.executor.gen.dto.PipelineExecutionState; +import com.autobuild.pipeline.executor.gen.dto.StageExecutionState; +import com.autobuild.pipeline.executor.entity.PipelineBuildEntity; +import com.autobuild.pipeline.executor.entity.StageBuildEntity; +import com.autobuild.pipeline.executor.execution.state.PipelineEntityExecutionState; +import com.autobuild.pipeline.executor.execution.state.StageEntityExecutionState; public class DummyData { //Pipeline Crud - public static Stage getStage() { - return new Stage(UUID.randomUUID(),"dummyStage1","bash","./dummyFolder/"); + public static StageEntity getStage() { + return new StageEntity(UUID.randomUUID(), "dummyStage1", "bash", "./dummyFolder/"); } - public static StageDTO getStageDTO() { - return new StageDTO(UUID.randomUUID(), "dummyStage1", "bash", "echo Hello"); + public static Stage getStageDTO() { + return Stage.newBuilder() + .setId(UUID.randomUUID().toString()) + .setName("dummyStage1") + .setScriptType("bash") + .setCommand("echo Hello") + .build(); } - public static Pipeline getPipeline() { - return new Pipeline(UUID.randomUUID(), "my pipeline",List.of(getStage())); + public static PipelineEntity getPipeline() { + return new PipelineEntity(UUID.randomUUID(), "my pipeline", List.of(getStage())); } - public static Pipeline getPipeline(UUID pipelineId) { - return new Pipeline(pipelineId, "my pipeline",List.of(getStage())); + public static PipelineEntity getPipeline(UUID pipelineId) { + return new PipelineEntity(pipelineId, "my pipeline", List.of(getStage())); } - public static PipelineDTO getPipelineDTO() { - return new PipelineDTO(UUID.randomUUID(), "my pipeline", List.of(getStageDTO())); + public static Pipeline getPipelineDTO() { + return Pipeline.newBuilder() + .setId(UUID.randomUUID().toString()) + .setName("my pipeline") + .addAllStages(List.of(getStageDTO())) + .build(); } //Pipeline Execution @@ -44,27 +55,44 @@ public static PipelineExecuteRequest getPipelineRequest() { return new PipelineExecuteRequest(UUID.randomUUID()); } - public static StageBuild getStageBuild() { - return new StageBuild(UUID.randomUUID(), DummyData.getStage(), StageExecutionState.WAITING, "./dummyFolder/"); + public static StageBuildEntity getStageBuild() { + return new StageBuildEntity(UUID.randomUUID(), DummyData.getStage(), StageEntityExecutionState.WAITING, "./dummyFolder/"); } - public static PipelineBuild getPipelineBuild() { - return new PipelineBuild(UUID.randomUUID(), DummyData.getPipeline(), List.of(DummyData.getStageBuild()), PipelineExecutionState.WAITING, null); + public static PipelineBuildEntity getPipelineBuild() { + return new PipelineBuildEntity(UUID.randomUUID(), DummyData.getPipeline(), List.of(DummyData.getStageBuild()), PipelineEntityExecutionState.WAITING, Instant.now()); } - public static PipelineBuild getPipelineBuild(UUID pipelineUuid) { - return new PipelineBuild(UUID.randomUUID(), DummyData.getPipeline(pipelineUuid), List.of(DummyData.getStageBuild()), PipelineExecutionState.WAITING, null); + public static PipelineBuildEntity getPipelineBuild(UUID pipelineUuid) { + return new PipelineBuildEntity(UUID.randomUUID(), DummyData.getPipeline(pipelineUuid), List.of(DummyData.getStageBuild()), PipelineEntityExecutionState.WAITING, Instant.now()); } - public static StageBuildDTO getStageBuildDTO() { - return new StageBuildDTO(UUID.randomUUID(), UUID.randomUUID(), "Dummy Stage", StageExecutionState.WAITING); + public static StageBuild getStageBuildDTO() { + return StageBuild.newBuilder() + .setId(UUID.randomUUID().toString()) + .setStageId(UUID.randomUUID().toString()) + .setStageName("Dummy Stage") + .setCurrentState(StageExecutionState.STAGE_WAITING) + .build(); } - public static PipelineBuildDTO getPipelineBuildDTO() { - return new PipelineBuildDTO(UUID.randomUUID(), UUID.randomUUID(), "Dummy Pipeline", PipelineExecutionState.WAITING, null, List.of(DummyData.getStageBuildDTO())); + public static PipelineBuild getPipelineBuildDTO() { + return PipelineBuild.newBuilder() + .setId(UUID.randomUUID().toString()) + .setPipelineId(UUID.randomUUID().toString()) + .setPipelineName("Dummy Pipeline") + .setCurrentState(PipelineExecutionState.PIPELINE_WAITING) + .addAllStageBuilds(List.of(DummyData.getStageBuildDTO())) + .build(); } - public static PipelineBuildDTO getPipelineBuildDTO(UUID pipelineId) { - return new PipelineBuildDTO(UUID.randomUUID(), pipelineId, "Dummy Pipeline", PipelineExecutionState.WAITING, null, List.of(DummyData.getStageBuildDTO())); + public static PipelineBuild getPipelineBuildDTO(UUID pipelineId) { + return PipelineBuild.newBuilder() + .setId(UUID.randomUUID().toString()) + .setPipelineId(pipelineId.toString()) + .setPipelineName("Dummy Pipeline") + .setCurrentState(PipelineExecutionState.PIPELINE_WAITING) + .addAllStageBuilds(List.of(DummyData.getStageBuildDTO())) + .build(); } -} \ No newline at end of file +} diff --git a/pipeline/src/test/java/com/autobuild/pipeline/utility/file/impl/LocalPipelineFileServiceImplTest.java b/pipeline/src/test/java/com/autobuild/pipeline/utility/file/impl/LocalPipelineFileServiceImplTest.java index b0d215d4f..4d9b8654f 100644 --- a/pipeline/src/test/java/com/autobuild/pipeline/utility/file/impl/LocalPipelineFileServiceImplTest.java +++ b/pipeline/src/test/java/com/autobuild/pipeline/utility/file/impl/LocalPipelineFileServiceImplTest.java @@ -16,16 +16,16 @@ import org.junit.jupiter.api.Test; import org.mockito.MockedStatic; -import com.autobuild.pipeline.definiton.dto.PipelineDTO; -import com.autobuild.pipeline.definiton.dto.StageDTO; -import com.autobuild.pipeline.definiton.entity.Pipeline; -import com.autobuild.pipeline.definiton.entity.Stage; +import com.autobuild.pipeline.definiton.gen.dto.Pipeline; +import com.autobuild.pipeline.definiton.gen.dto.Stage; +import com.autobuild.pipeline.definiton.entity.PipelineEntity; +import com.autobuild.pipeline.definiton.entity.StageEntity; import com.autobuild.pipeline.testutility.DummyData; import com.autobuild.pipeline.utility.file.PipelineFileService; public class LocalPipelineFileServiceImplTest { - private Pipeline pipeline = DummyData.getPipeline(); - private PipelineDTO pipelineDTO = DummyData.getPipelineDTO(); + private PipelineEntity pipeline = DummyData.getPipeline(); + private Pipeline pipelineDTO = DummyData.getPipelineDTO(); private Path pipelinePath = Path.of("..", "pipeline_scripts", pipeline.getId().toString()); @@ -38,7 +38,7 @@ public void setUp() { filesMockedStatic = mockStatic(Files.class); filesMockedStatic.when(() -> Files.readAllLines(any(Path.class))) - .thenReturn(List.of(pipelineDTO.getStages().get(0).getCommand())); + .thenReturn(List.of(pipelineDTO.getStagesList().get(0).getCommand())); filesMockedStatic.when(() -> Files.exists(any(Path.class))).thenReturn(false); filesMockedStatic.when(() -> Files.createDirectory(any(Path.class), any(FileAttribute.class))) .thenReturn(pipelinePath); @@ -103,7 +103,7 @@ public void testRemoveScriptFilesWithEntity() throws IOException { @Test public void testCreateStageScriptFile() throws IOException { - StageDTO newStage = pipelineDTO.getStages().get(0); + Stage newStage = pipelineDTO.getStagesList().get(0); String path = pipelineFileService.createStageScriptFile(pipeline, newStage); // Two exists checks: parent directory + pipeline directory @@ -117,7 +117,7 @@ public void testCreateStageScriptFile() throws IOException { @Test public void testUpdateStageScriptFile() throws IOException { - Stage stage = pipeline.getStages().get(0); + StageEntity stage = pipeline.getStages().get(0); stage.setPath(pipelinePath.resolve(stage.getId().toString()).toString()); pipelineFileService.updateStageScriptFile(stage, "#!/bin/bash\necho UPDATED"); @@ -127,7 +127,7 @@ public void testUpdateStageScriptFile() throws IOException { @Test public void testRemoveStageScriptFile() throws IOException { - Stage stage = pipeline.getStages().get(0); + StageEntity stage = pipeline.getStages().get(0); stage.setPath(pipelinePath.resolve(stage.getId().toString()).toString()); pipelineFileService.removeStageScriptFile(stage); @@ -137,18 +137,18 @@ public void testRemoveStageScriptFile() throws IOException { @Test public void testReadStageScriptFile() throws IOException { - Stage stage = pipeline.getStages().get(0); + StageEntity stage = pipeline.getStages().get(0); stage.setPath(pipelinePath.resolve(stage.getId().toString()).toString()); String content = pipelineFileService.readStageScriptFile(stage); filesMockedStatic.verify(() -> Files.readAllLines(any(Path.class)), times(1)); - assert content.equals(pipelineDTO.getStages().get(0).getCommand()); + assert content.equals(pipelineDTO.getStagesList().get(0).getCommand()); } @Test public void testReadStageScriptFileBlankPath() throws IOException { - Stage stage = new Stage(); + StageEntity stage = new StageEntity(); stage.setPath(""); String content = pipelineFileService.readStageScriptFile(stage); assert content.isEmpty();