CB-16056 Support recipes for FreeIPA provisioning/termination

It is phase1 implementation. I will rename CM recipe types like post_CM_install to something like post_service_install etc, but not in this PR, it will be a separated PR. Attaching / detaching recipes are not supported yet, but it is part of the plan, so it will be implemented in phase2.
Recipes saved into both env service then freeipa service because of restartable flows. Salt states moved to the common salt directory and reused the whole original salt logic.

Author: sodre90

core-common/build.gradle

@@ -0,0 +1,16 @@
+plugins {
+  id "java"
+}
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+
+  implementation project(":core-api")
+  implementation project(":common")
+
+  testImplementation group: 'org.assertj', name: 'assertj-core', version: assertjVersion
+
+}

core-common/src/main/java/com/sequenceiq/cloudbreak/recipe/RecipeCrnListProviderService.java

@@ -0,0 +1,44 @@
+package com.sequenceiq.cloudbreak.recipe;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import javax.inject.Inject;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Service;
+
+import com.sequenceiq.cloudbreak.api.endpoint.v4.common.CompactViewV4Response;
+import com.sequenceiq.cloudbreak.api.endpoint.v4.recipes.RecipeV4Endpoint;
+import com.sequenceiq.cloudbreak.api.endpoint.v4.recipes.responses.RecipeViewV4Responses;
+import com.sequenceiq.cloudbreak.common.exception.NotFoundException;
+
+@Service
+public class RecipeCrnListProviderService {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(RecipeCrnListProviderService.class);
+
+    @Inject
+    private RecipeV4Endpoint recipeV4Endpoint;
+
+    public List<String> getResourceCrnListByResourceNameList(List<String> resourceNames) {
+        LOGGER.info("Get resources crn list for recipes: {}", resourceNames);
+        RecipeViewV4Responses recipes = recipeV4Endpoint.list(0L);
+        validateRequestedRecipesExistsByName(resourceNames, recipes);
+        List<String> resourceCrns = recipes.getResponses().stream()
+                .filter(recipe -> resourceNames.contains(recipe.getName())).map(CompactViewV4Response::getCrn).collect(Collectors.toList());
+        LOGGER.info("Resource crns for recipes: {}", resourceCrns);
+        return resourceCrns;
+    }
+
+    private void validateRequestedRecipesExistsByName(List<String> resourceNames, RecipeViewV4Responses recipes) {
+        List<String> recipeNamesFromCore = recipes.getResponses().stream().map(CompactViewV4Response::getName).collect(Collectors.toList());
+        List<String> recipesNotFound = resourceNames.stream().filter(recipeName -> !recipeNamesFromCore.contains(recipeName)).collect(Collectors.toList());
+        if (recipesNotFound.size() > 0) {
+            LOGGER.info("Missing recipes: {}", recipesNotFound);
+            throw new NotFoundException("Following recipes does not exist: " + recipesNotFound);
+        }
+    }
+
+}

core-common/src/test/java/com/sequenceiq/cloudbreak/recipe/RecipeCrnListProviderServiceTest.java

@@ -0,0 +1,59 @@
+package com.sequenceiq.cloudbreak.recipe;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.when;
+
+import java.util.List;
+import java.util.Set;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import com.sequenceiq.cloudbreak.api.endpoint.v4.recipes.RecipeV4Endpoint;
+import com.sequenceiq.cloudbreak.api.endpoint.v4.recipes.responses.RecipeViewV4Response;
+import com.sequenceiq.cloudbreak.api.endpoint.v4.recipes.responses.RecipeViewV4Responses;
+import com.sequenceiq.cloudbreak.common.exception.NotFoundException;
+
+@ExtendWith(MockitoExtension.class)
+class RecipeCrnListProviderServiceTest {
+
+    @Mock
+    private RecipeV4Endpoint recipeV4Endpoint;
+
+    @InjectMocks
+    private RecipeCrnListProviderService recipeCrnListProviderService;
+
+    @Test
+    public void testGetResourceCrnListByResourceNameList() {
+        RecipeViewV4Responses recipeViewV4Responses = new RecipeViewV4Responses();
+        RecipeViewV4Response recipeResponse1 = new RecipeViewV4Response();
+        recipeResponse1.setName("recipe1");
+        recipeResponse1.setCrn("crn1");
+        RecipeViewV4Response recipeResponse2 = new RecipeViewV4Response();
+        recipeResponse2.setName("recipe2");
+        recipeResponse2.setCrn("crn2");
+        recipeViewV4Responses.setResponses(Set.of(recipeResponse1, recipeResponse2));
+        when(recipeV4Endpoint.list(any())).thenReturn(recipeViewV4Responses);
+        List<String> resourceCrnListByResourceNameList = recipeCrnListProviderService.getResourceCrnListByResourceNameList(List.of("recipe1", "recipe2"));
+        assertThat(resourceCrnListByResourceNameList).containsExactlyInAnyOrder("crn1", "crn2");
+    }
+
+    @Test
+    public void testGetResourceCrnListByResourceNameListButOnlyOneRecipeWasFound() {
+        RecipeViewV4Responses recipeViewV4Responses = new RecipeViewV4Responses();
+        RecipeViewV4Response recipeResponse1 = new RecipeViewV4Response();
+        recipeResponse1.setName("recipe1");
+        recipeResponse1.setCrn("crn1");
+        recipeViewV4Responses.setResponses(Set.of(recipeResponse1));
+        when(recipeV4Endpoint.list(any())).thenReturn(recipeViewV4Responses);
+        NotFoundException cloudbreakRuntimeException = Assertions.assertThrows(NotFoundException.class,
+                () -> recipeCrnListProviderService.getResourceCrnListByResourceNameList(List.of("recipe1", "recipe2")));
+        Assertions.assertEquals("Following recipes does not exist: [recipe2]", cloudbreakRuntimeException.getMessage());
+    }
+
+}

core/src/main/java/com/sequenceiq/cloudbreak/converter/v4/recipes/RecipeToRecipeV4RequestConverter.java

@@ -15,7 +15,7 @@ public class RecipeToRecipeV4RequestConverter {
 
     public RecipeV4Request convert(Recipe source) {
         RecipeV4Request recipeRequest = new RecipeV4Request();
-        recipeRequest.setName("");
+        recipeRequest.setName(source.getName());
         recipeRequest.setDescription(source.getDescription());
         recipeRequest.setType(RecipeV4Type.valueOf(source.getRecipeType().name()));
         recipeRequest.setContent(source.getContent());

core/src/test/java/com/sequenceiq/cloudbreak/converter/v4/recipes/RecipeToRecipeV4RequestConverterTest.java

@@ -0,0 +1,35 @@
+package com.sequenceiq.cloudbreak.converter.v4.recipes;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import com.sequenceiq.cloudbreak.api.endpoint.v4.recipes.requests.RecipeV4Request;
+import com.sequenceiq.cloudbreak.api.endpoint.v4.recipes.requests.RecipeV4Type;
+import com.sequenceiq.cloudbreak.common.model.recipe.RecipeType;
+import com.sequenceiq.cloudbreak.domain.Recipe;
+
+@ExtendWith(MockitoExtension.class)
+class RecipeToRecipeV4RequestConverterTest {
+
+    @InjectMocks
+    private RecipeToRecipeV4RequestConverter recipeToRecipeV4RequestConverter;
+
+    @Test
+    public void testRecipeToRecipeV4RequestConverter() {
+        Recipe source = new Recipe();
+        source.setName("recipeName");
+        source.setRecipeType(RecipeType.POST_CLUSTER_INSTALL);
+        source.setContent("content");
+        source.setDescription("description");
+        RecipeV4Request converted = recipeToRecipeV4RequestConverter.convert(source);
+        assertEquals(converted.getName(), source.getName());
+        assertEquals(converted.getType(), RecipeV4Type.POST_CLUSTER_INSTALL);
+        assertEquals(converted.getDescription(), source.getDescription());
+        assertEquals(converted.getContent(), source.getContent());
+    }
+
+}

environment-api/src/main/java/com/sequenceiq/environment/api/doc/environment/EnvironmentModelDescription.java

@@ -128,6 +128,7 @@ public class EnvironmentModelDescription {
     public static final String ENCRYPTION_KEY = "Key Resource of the Customer Managed Encryption Key to encrypt GCP resources";
 
     public static final String FREEIPA_AWS_PARAMETERS = "Aws specific FreeIpa parameters";
+    public static final String FREEIPA_RECIPE_LIST = "FreeIpa recipe list";
     public static final String FREEIPA_AZURE_PARAMETERS = "Azure specific FreeIpa parameters";
     public static final String FREEIPA_GCP_PARAMETERS = "Gcp specific FreeIpa parameters";
     public static final String FREEIPA_AWS_SPOT_PARAMETERS = "Aws spot instance related parameters.";

environment-api/src/main/java/com/sequenceiq/environment/api/v1/environment/model/request/AttachedFreeIpaRequest.java

@@ -1,6 +1,7 @@
 package com.sequenceiq.environment.api.v1.environment.model.request;
 
 import java.io.Serializable;
+import java.util.Set;
 
 import javax.validation.Valid;
 import javax.validation.constraints.NotNull;
@@ -31,6 +32,9 @@ public class AttachedFreeIpaRequest implements Serializable {
     @ApiModelProperty(value = EnvironmentModelDescription.MULTIAZ_FREEIPA)
     private boolean enableMultiAz;
 
+    @ApiModelProperty(EnvironmentModelDescription.FREEIPA_RECIPE_LIST)
+    private Set<String> recipes;
+
     @Valid
     @ApiModelProperty(EnvironmentModelDescription.FREEIPA_AWS_PARAMETERS)
     private AwsFreeIpaParameters aws;
@@ -124,4 +128,13 @@ public boolean isEnableMultiAz() {
     public void setEnableMultiAz(boolean enableMultiAz) {
         this.enableMultiAz = enableMultiAz;
     }
+
+    public Set<String> getRecipes() {
+        return recipes;
+    }
+
+    public void setRecipes(Set<String> recipes) {
+        this.recipes = recipes;
+    }
+
 }

environment/build.gradle

@@ -52,6 +52,7 @@ dependencies {
     implementation project(':audit-connector')
     implementation     project(":authorization-common")
     implementation     project(":common")
+    implementation     project(':core-common')
     implementation     project(":secret-engine")
     implementation     project(":flow")
     implementation     project(":auth-connector")

environment/src/main/java/com/sequenceiq/environment/environment/domain/EnvironmentView.java

@@ -5,9 +5,12 @@
 import java.util.Set;
 
 import javax.persistence.CascadeType;
+import javax.persistence.CollectionTable;
 import javax.persistence.Column;
 import javax.persistence.Convert;
+import javax.persistence.ElementCollection;
 import javax.persistence.Entity;
+import javax.persistence.FetchType;
 import javax.persistence.JoinColumn;
 import javax.persistence.ManyToOne;
 import javax.persistence.OneToOne;
@@ -124,6 +127,11 @@ public class EnvironmentView extends CompactView implements AuthResource {
 
     private String freeIpaImageId;
 
+    @ElementCollection(fetch = FetchType.EAGER)
+    @CollectionTable(name = "environment_freeiparecipes", joinColumns = @JoinColumn(name = "environment_id", referencedColumnName = "id"))
+    @Column(name = "recipe")
+    private Set<String> freeipaRecipes;
+
     @Column(nullable = false)
     private boolean freeIpaEnableMultiAz;
 
@@ -481,6 +489,14 @@ public void setFreeIpaEnableMultiAz(boolean freeIpaEnableMultiAz) {
         this.freeIpaEnableMultiAz = freeIpaEnableMultiAz;
     }
 
+    public Set<String> getFreeipaRecipes() {
+        return freeipaRecipes;
+    }
+
+    public void setFreeipaRecipes(Set<String> freeipaRecipes) {
+        this.freeipaRecipes = freeipaRecipes;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) {
@@ -514,6 +530,7 @@ public String toString() {
                 ", accountId='" + accountId + '\'' +
                 ", resourceCrn='" + resourceCrn + '\'' +
                 ", status=" + status +
+                ", freeipaRecipes='" + freeipaRecipes + '\'' +
                 ", deletionType=" + deletionType +
                 '}';
     }

environment/src/main/java/com/sequenceiq/environment/environment/domain/FreeIpaRecipe.java

@@ -0,0 +1,66 @@
+package com.sequenceiq.environment.environment.domain;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.SequenceGenerator;
+import javax.persistence.Table;
+
+@Entity
+@Table(name = "environment_freeiparecipes")
+public class FreeIpaRecipe {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.AUTO, generator = "environment_freeiparecipes_generator")
+    @SequenceGenerator(name = "environment_freeiparecipes_generator", sequenceName = "environment_freeiparecipes_id_seq", allocationSize = 1)
+    private Long id;
+
+    @Column(name = "environment_id")
+    private long environmentId;
+
+    private String recipe;
+
+    public FreeIpaRecipe() {
+    }
+
+    public FreeIpaRecipe(long environmentId, String recipe) {
+        this.environmentId = environmentId;
+        this.recipe = recipe;
+    }
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public long getEnvironmentId() {
+        return environmentId;
+    }
+
+    public void setEnvironmentId(long environmentId) {
+        this.environmentId = environmentId;
+    }
+
+    public String getRecipe() {
+        return recipe;
+    }
+
+    public void setRecipe(String recipe) {
+        this.recipe = recipe;
+    }
+
+    @Override
+    public String toString() {
+        return "FreeIpaRecipe{" +
+                "id=" + id +
+                ", environmentId=" + environmentId +
+                ", recipe='" + recipe + '\'' +
+                '}';
+    }
+
+}