apply yaml model interface

Author: gy2006

src/main/java/com/flowci/build/business/impl/CreateBuildImpl.java

@@ -5,19 +5,23 @@
 import com.flowci.build.model.BuildYaml;
 import com.flowci.build.repo.BuildRepo;
 import com.flowci.build.repo.BuildYamlRepo;
+import com.flowci.build.repo.JobRepo;
 import com.flowci.common.RequestContextHolder;
 import com.flowci.common.model.Variables;
 import com.flowci.flow.business.FetchFlow;
 import com.flowci.flow.business.FetchFlowYamlContent;
 import com.flowci.flow.model.Flow;
-import com.flowci.yaml.business.ParseYamlV2;
+import com.flowci.yaml.business.ParseYaml;
+import com.flowci.yaml.model.Command;
+import com.flowci.yaml.model.Step;
 import jakarta.annotation.Nullable;
 import jakarta.transaction.Transactional;
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
 
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 
 @Slf4j
@@ -27,9 +31,10 @@ public class CreateBuildImpl implements CreateBuild {
 
     private final FetchFlow fetchFlow;
     private final FetchFlowYamlContent fetchFlowYamlContent;
-    private final ParseYamlV2 parseYamlV2;
+    private final ParseYaml parseYamlV2;
     private final BuildRepo buildRepo;
     private final BuildYamlRepo buildYamlRepo;
+    private final JobRepo jobRepo;
     private final RequestContextHolder requestContextHolder;
 
     @Override
@@ -45,21 +50,22 @@ public Build invoke(Long flowId, Build.Trigger trigger, @Nullable Variables inpu
 
         var build = new Build();
         build.setFlowId(flow.getId());
+        build.setContext(toBuildVariables(flow, inputs));
         build.setTrigger(trigger);
         build.setStatus(Build.Status.CREATED);
-        build.setAgentTags(agentTags.toArray(new String[0]));
+
         build.setCreatedBy(requestContextHolder.getUserId());
         build.setUpdatedBy(requestContextHolder.getUserId());
         buildRepo.save(build);
 
         var buildYaml = new BuildYaml();
         buildYaml.setId(build.getId());
-        buildYaml.setVariables(toBuildVariables(flow, inputs));
         buildYaml.setYaml(yaml);
         buildYaml.setCreatedBy(build.getCreatedBy());
         buildYaml.setUpdatedBy(build.getUpdatedBy());
         buildYamlRepo.save(buildYaml);
 
+
         log.info("build {} is created for flow {} with trigger {}", build.getBuildAlias(), flowId, trigger);
         return build;
     }

src/main/java/com/flowci/build/model/Build.java

@@ -1,6 +1,7 @@
 package com.flowci.build.model;
 
 import com.flowci.common.model.EntityBase;
+import com.flowci.common.model.Variables;
 import io.hypersistence.utils.hibernate.type.array.StringArrayType;
 import io.hypersistence.utils.hibernate.type.json.JsonType;
 import jakarta.annotation.Nullable;
@@ -77,15 +78,9 @@ public enum Status {
     @Enumerated(EnumType.STRING)
     private Status status;
 
-    @org.hibernate.annotations.Type(StringArrayType.class)
-    private String[] agentTags;
-
     @Type(JsonType.class)
     private GitRef gitRef;
 
-    /**
-     * Assigned agent id
-     */
-    @Nullable
-    private Long agentId;
+    @Type(JsonType.class)
+    private Variables context;
 }

src/main/java/com/flowci/build/model/BuildYaml.java

@@ -1,14 +1,11 @@
 package com.flowci.build.model;
 
 import com.flowci.common.model.EntityBase;
-import com.flowci.common.model.Variables;
-import io.hypersistence.utils.hibernate.type.json.JsonType;
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;
 import jakarta.persistence.Table;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
-import org.hibernate.annotations.Type;
 
 @Data
 @Entity
@@ -19,9 +16,5 @@ public class BuildYaml extends EntityBase {
     @Id
     private Long id;
 
-    // ref to flow variables and extra inputs
-    @Type(JsonType.class)
-    private Variables variables;
-
     private String yaml;
 }

src/main/java/com/flowci/build/model/Job.java

@@ -0,0 +1,77 @@
+package com.flowci.build.model;
+
+import com.flowci.common.model.EntityBase;
+import com.flowci.common.model.Variables;
+import io.hypersistence.utils.hibernate.type.array.LongArrayType;
+import io.hypersistence.utils.hibernate.type.array.StringArrayType;
+import io.hypersistence.utils.hibernate.type.json.JsonType;
+import jakarta.annotation.Nullable;
+import jakarta.persistence.*;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import org.hibernate.annotations.Type;
+
+import java.util.Map;
+
+/**
+ * Job refer to Step from YAML
+ */
+@Data
+@Entity
+@Table(name = "jobs")
+@EqualsAndHashCode(of = "id", callSuper = false)
+public class Job extends EntityBase {
+
+    public enum Status {
+        CREATED, // init status
+        QUEUED, // been put to job queue and waiting for agent
+        ASSIGNED, // assigned to an agent
+        RUNNING, // agent start to execute the flow
+        CANCELLING, // will be cancelled, but waiting for response from agent
+        SUCCESS,
+        FAILURE,
+        CANCELLED,
+        TIMEOUT
+    }
+
+    @Id
+    private Long id;
+
+    private Long buildId;
+
+    private String name;
+
+    /**
+     * Dependency job id list
+     */
+    @org.hibernate.annotations.Type(LongArrayType.class)
+    private Long[] dependencies;
+
+    @Enumerated(EnumType.STRING)
+    private Status status;
+
+    @Nullable
+    @org.hibernate.annotations.Type(StringArrayType.class)
+    private String[] agentTags;
+
+    /**
+     * Assigned agent id
+     */
+    @Nullable
+    private Long agentId;
+
+    /**
+     * All input variables
+     * value assigned when agent assigned, need to take build context
+     */
+    @Nullable
+    @Type(JsonType.class)
+    private Variables variables;
+
+    /**
+     * Environment variables with value
+     */
+    @Nullable
+    @Type(JsonType.class)
+    private Map<String, String> output;
+}

src/main/java/com/flowci/build/repo/JobRepo.java

@@ -0,0 +1,9 @@
+package com.flowci.build.repo;
+
+import com.flowci.build.model.Job;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface JobRepo extends JpaRepository<Job, Long> {
+}

src/main/java/com/flowci/flow/business/impl/UpdateFlowYamlContentImpl.java

@@ -4,7 +4,7 @@
 import com.flowci.common.exception.NotAvailableException;
 import com.flowci.flow.business.UpdateFlowYamlContent;
 import com.flowci.flow.repo.FlowYamlRepo;
-import com.flowci.yaml.business.ParseYamlV2;
+import com.flowci.yaml.business.ParseYaml;
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
@@ -18,7 +18,7 @@
 @AllArgsConstructor
 public class UpdateFlowYamlContentImpl implements UpdateFlowYamlContent {
 
-    private final ParseYamlV2 parseYamlV2;
+    private final ParseYaml parseYamlV2;
     private final FlowYamlRepo flowYamlRepo;
     private final RequestContextHolder requestContextHolder;
 

src/main/java/com/flowci/yaml/business/ParseYaml.java

@@ -0,0 +1,7 @@
+package com.flowci.yaml.business;
+
+import com.flowci.yaml.model.Flow;
+
+public interface ParseYaml {
+    Flow invoke(String yaml);
+}

src/main/java/com/flowci/yaml/business/ParseYamlV2.java

@@ -4,23 +4,25 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 import com.flowci.common.validator.ValidName;
-import com.flowci.yaml.business.ParseYamlV2;
+import com.flowci.yaml.business.ParseYaml;
 import com.flowci.yaml.exception.InvalidYamlException;
-import com.flowci.yaml.model.FlowV2;
-import com.flowci.yaml.model.StepV2;
+import com.flowci.yaml.model.Step;
+import com.flowci.yaml.model.v2.FlowV2;
+import com.flowci.yaml.model.v2.StepV2;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
-import org.springframework.util.CollectionUtils;
 
-import java.util.*;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
 
 import static java.lang.String.format;
 import static org.springframework.util.CollectionUtils.isEmpty;
 import static org.springframework.util.StringUtils.hasText;
 
 @Slf4j
 @Component
-public class ParseYamlV2Impl implements ParseYamlV2 {
+public class ParseYamlV2Impl implements ParseYaml {
 
     private static final ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
     private static final ValidName.NameValidator nameValidator = new ValidName.NameValidator();
@@ -34,7 +36,9 @@ public FlowV2 invoke(String yaml) {
         try {
             var flowV2 = objectMapper.readValue(yaml, FlowV2.class);
             for (var step : flowV2.getSteps()) {
-                step.setParent(flowV2);
+                if (step instanceof StepV2 v2) {
+                    v2.setParent(flowV2);
+                }
             }
 
             validateSteps(flowV2);
@@ -48,7 +52,7 @@ public FlowV2 invoke(String yaml) {
 
     private void validateSteps(FlowV2 flow) {
         var steps = flow.getSteps();
-        if (CollectionUtils.isEmpty(steps)) {
+        if (isEmpty(steps)) {
             throw new InvalidYamlException("at least one step is required");
         }
 
@@ -78,7 +82,7 @@ private void validateSteps(FlowV2 flow) {
 
     private void validateCommands(StepV2 step) {
         var commands = step.getCommands();
-        if (CollectionUtils.isEmpty(commands)) {
+        if (isEmpty(commands)) {
             throw new InvalidYamlException(format("at least one command under step '%s' is required", step.getName()));
         }
 
@@ -101,7 +105,7 @@ private void buildGraph(FlowV2 flow) {
         }
 
         for (var step : steps) {
-            if (CollectionUtils.isEmpty(step.getDependsOn())) {
+            if (isEmpty(step.getDependsOn())) {
                 continue;
             }
 
@@ -118,7 +122,7 @@ private void buildGraph(FlowV2 flow) {
         }
     }
 
-    private void checkCircularDependencies(List<StepV2> steps, HashMap<StepV2, Integer> traversed) {
+    private void checkCircularDependencies(List<Step> steps, HashMap<Step, Integer> traversed) {
         for (var step : steps) {
             Integer numEncountered = traversed.get(step);
 
@@ -137,13 +141,4 @@ private void checkCircularDependencies(List<StepV2> steps, HashMap<StepV2, Integ
             checkCircularDependencies(step.getNext(), traversed);
         }
     }
-
-    /**
-     * Ex:
-     *  A <-- B <-- C
-     *  A <-- C
-     */
-    private void checkDuplicatedDependsOn(List<StepV2> steps) {
-
-    }
 }

src/main/java/com/flowci/yaml/business/impl/ParseYamlV2Impl.java

@@ -0,0 +1,21 @@
+package com.flowci.yaml.model;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+public interface Base<D extends Docker> {
+
+    Map<String, String> getVariables();
+
+    // condition script , todo: python or groovy?
+    String getCondition();
+
+    Integer getTimeout();
+
+    Set<String> getAgents();
+
+    D getDocker();
+
+    List<D> getDockers();
+}