implement DB schema and start implementing registerIacTemplate API

Author: bernardodemarco

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -1332,6 +1332,10 @@ public class ApiConstants {
     public static final String INPUTS = "inputs";
     public static final String IAC_RESOURCE_TYPE_CONTENT = "iacresourcetypecontent";
     public static final String SHOW_IAC_RESOURCE_TYPE_CONTENT = "showiacresourcetypecontent";
+    public static final String IAC_TEMPLATE_CONTENT = "iactemplatecontent";
+    public static final String SHARED_DOMAIN_IDS = "shareddomainids";
+    public static final String SHARED_ACCOUNT_IDS = "sharedaccountids";
+    public static final String SHARED_PROJECT_IDS = "sharedprojectids";
 
     public static final String PARAMETER_DESCRIPTION_ACTIVATION_RULE = "Quota tariff's activation rule. It can receive a JS script that results in either " +
             "a boolean or a numeric value: if it results in a boolean value, the tariff value will be applied according to the result; if it results in a numeric value, the " +

engine/schema/src/main/resources/META-INF/db/schema-42100to42200.sql

@@ -29,3 +29,35 @@ CREATE TABLE IF NOT EXISTS `cloud`.`iac_resource_types` (
     `content` TEXT NOT NULL COMMENT 'Profile''s element content.',
     PRIMARY KEY (`id`)
 );
+
+CREATE TABLE IF NOT EXISTS `cloud`.`iac_templates` (
+    `id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT,
+    `uuid` VARCHAR(40) NOT NULL UNIQUE,
+    `name` VARCHAR(2048) NOT NULL,
+    `description` VARCHAR(4096),
+    `iac_template_content` TEXT NOT NULL,
+    `recursive_domains` TINYINT(1) NOT NULL DEFAULT 0,
+    `domain_id` BIGINT(20) UNSIGNED NOT NULL,
+    `account_id` BIGINT(20) UNSIGNED NOT NULL,
+    `created` DATETIME NOT NULL,
+    `removed` DATETIME,
+    PRIMARY KEY (`id`),
+    CONSTRAINT `fk_iac_templates__domain_id` FOREIGN KEY (`domain_id`) REFERENCES `domain`(`id`),
+    CONSTRAINT `fk_iac_templates__account_id` FOREIGN KEY (`account_id`) REFERENCES `account`(`id`)
+);
+
+CREATE TABLE IF NOT EXISTS `cloud`.`iac_template_account_map` (
+    `iac_template_id` BIGINT(20) UNSIGNED NOT NULL,
+    `account_id` BIGINT(20) UNSIGNED NOT NULL,
+    PRIMARY KEY (`iac_template_id`, `account_id`),
+    CONSTRAINT `fk_iac_template_account_map__iac_template_id` FOREIGN KEY (`iac_template_id`) REFERENCES `iac_templates`(`id`),
+    CONSTRAINT `fk_iac_template_account_map__account_id` FOREIGN KEY (`account_id`) REFERENCES `account`(`id`)
+);
+
+CREATE TABLE IF NOT EXISTS `cloud`.`iac_template_domain_map` (
+    `iac_template_id` BIGINT(20) UNSIGNED NOT NULL,
+    `domain_id` BIGINT(20) UNSIGNED NOT NULL,
+    PRIMARY KEY (`iac_template_id`, `domain_id`),
+    CONSTRAINT `fk_iac_template_domain_map__iac_template_id` FOREIGN KEY (`iac_template_id`) REFERENCES `iac_templates`(`id`),
+    CONSTRAINT `fk_iac_template_domain_map__domain_id` FOREIGN KEY (`domain_id`) REFERENCES `domain`(`id`)
+);

plugins/iac/nimble/src/main/java/org/apache/cloudstack/api/command/RegisterIacTemplateCmd.java

@@ -0,0 +1,79 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.api.command;
+
+import org.apache.cloudstack.acl.RoleType;
+import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.BaseCmd;
+import org.apache.cloudstack.api.Parameter;
+import org.apache.cloudstack.api.response.DomainResponse;
+import org.apache.cloudstack.api.response.IacTemplateResponse;
+import org.apache.cloudstack.api.response.ProjectResponse;
+import org.apache.cloudstack.persistence.iactemplates.IacTemplate;
+import org.apache.cloudstack.service.NimbleService;
+
+import javax.inject.Inject;
+
+@APICommand(name = "registerIacTemplate",
+        description = "Register an IaC template, such as a TOSCA service template.",
+        responseObject = IacTemplateResponse.class, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false,
+        entityType = {IacTemplate.class}, authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
+public class RegisterIacTemplateCmd extends BaseCmd {
+    @Inject
+    private NimbleService nimbleService;
+
+    @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the IaC template.", required = true)
+    private String name;
+
+    @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the IaC template.")
+    private String description;
+
+    @Parameter(name = ApiConstants.IAC_TEMPLATE_CONTENT, type = CommandType.STRING, length = 65535, description = "The content of the IaC template.", required = true)
+    private String iacTemplateContent;
+
+    @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "ID of the domain associated with the IaC template. It must be used along with the \"account\" parameter.")
+    private Long domainId;
+
+    @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The name of the account owner of the IaC template. It must be used along with the \"domainid\" parameter.")
+    private String accountName;
+
+    @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "ID of the project owner of the IaC template. Mutually exclusive with the \"account\" parameter.")
+    private Long projectId;
+
+    @Parameter(name = ApiConstants.SHARED_DOMAIN_IDS, type = CommandType.STRING, description = "")
+    private String sharedDomainIds;
+
+    @Parameter(name = ApiConstants.SHARED_ACCOUNT_IDS, type = CommandType.STRING, description = "")
+    private String sharedAccountIds;
+
+    @Parameter(name = ApiConstants.SHARED_PROJECT_IDS, type = CommandType.STRING, description = "")
+    private String sharedProjectIds;
+
+    @Parameter(name = ApiConstants.RECURSIVE_DOMAINS, type = CommandType.BOOLEAN, description = "Defines whether IaC template will be shared among the subdomains of the informed domains in the \"shareddomainids\" parameter. Defaults to false.")
+    private boolean recursiveDomains = false;
+    
+    @Override
+    public void execute() {
+
+    }
+
+    @Override
+    public long getEntityOwnerId() {
+        return 0;
+    }
+}

plugins/iac/nimble/src/main/java/org/apache/cloudstack/api/response/IacTemplateResponse.java

@@ -0,0 +1,25 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.api.response;
+
+import org.apache.cloudstack.api.BaseResponse;
+import org.apache.cloudstack.api.EntityReference;
+import org.apache.cloudstack.persistence.iactemplates.IacTemplate;
+
+@EntityReference(value = {IacTemplate.class})
+public class IacTemplateResponse extends BaseResponse {
+}

plugins/iac/nimble/src/main/java/org/apache/cloudstack/persistence/iactemplates/IacTemplate.java

@@ -0,0 +1,32 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.persistence.iactemplates;
+
+import org.apache.cloudstack.acl.ControlledEntity;
+import org.apache.cloudstack.api.Identity;
+import org.apache.cloudstack.api.InternalIdentity;
+
+import java.util.Date;
+
+public interface IacTemplate extends InternalIdentity, Identity, ControlledEntity {
+    String getName();
+    String getDescription();
+    String getIacTemplateContent();
+    boolean isRecursiveDomains();
+    Date getCreated();
+    Date getRemoved();
+}

plugins/iac/nimble/src/main/java/org/apache/cloudstack/persistence/iactemplates/IacTemplateAccountMapVO.java

@@ -0,0 +1,31 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.persistence.iactemplates;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.Table;
+
+@Entity
+@Table(name = "iac_template_account_map")
+public class IacTemplateAccountMapVO {
+    @Column(name = "iac_template_id", nullable = false)
+    private long iacTemplateId;
+
+    @Column(name = "account_id", nullable = false)
+    private long accountId;
+}

plugins/iac/nimble/src/main/java/org/apache/cloudstack/persistence/iactemplates/IacTemplateDomainMapVO.java

@@ -0,0 +1,31 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.persistence.iactemplates;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.Table;
+
+@Entity
+@Table(name = "iac_template_domain_map")
+public class IacTemplateDomainMapVO {
+    @Column(name = "iac_template_id", nullable = false)
+    private long iacTemplateId;
+
+    @Column(name = "domain_id", nullable = false)
+    private long domainId;
+}

plugins/iac/nimble/src/main/java/org/apache/cloudstack/persistence/iactemplates/IacTemplateVO.java

@@ -0,0 +1,123 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+package org.apache.cloudstack.persistence.iactemplates;
+
+import com.cloud.utils.db.GenericDao;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.Table;
+import javax.persistence.Temporal;
+import javax.persistence.TemporalType;
+import java.util.Date;
+import java.util.UUID;
+
+@Entity
+@Table(name = "iac_templates")
+public class IacTemplateVO implements IacTemplate {
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    @Column(name = "id", nullable = false)
+    private Long id;
+
+    @Column(name = "uuid", nullable = false)
+    private String uuid = UUID.randomUUID().toString();
+
+    @Column(name = "name", nullable = false, length = 2048)
+    private String name;
+
+    @Column(name = "description", length = 4096)
+    private String description;
+
+    @Column(name = "iac_template_content", nullable = false, length = 65535)
+    private String iacTemplateContent;
+
+    @Column(name = "recursive_domains", nullable = false)
+    private boolean recursiveDomains;
+
+    @Column(name = "domain_id", nullable = false)
+    private long domainId;
+
+    @Column(name = "account_id", nullable = false)
+    private long accountId;
+
+    @Column(name = GenericDao.CREATED_COLUMN, nullable = false)
+    @Temporal(value = TemporalType.TIMESTAMP)
+    private Date created;
+
+    @Column(name = GenericDao.REMOVED_COLUMN)
+    @Temporal(value = TemporalType.TIMESTAMP)
+    private Date removed;
+
+    @Override
+    public long getId() {
+        return id;
+    }
+
+    @Override
+    public String getUuid() {
+        return uuid;
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public String getDescription() {
+        return description;
+    }
+
+    @Override
+    public String getIacTemplateContent() {
+        return iacTemplateContent;
+    }
+
+    @Override
+    public boolean isRecursiveDomains() {
+        return recursiveDomains;
+    }
+
+    @Override
+    public long getDomainId() {
+        return domainId;
+    }
+
+    @Override
+    public long getAccountId() {
+        return accountId;
+    }
+
+    @Override
+    public Date getCreated() {
+        return created;
+    }
+
+    @Override
+    public Date getRemoved() {
+        return removed;
+    }
+
+    @Override
+    public Class<?> getEntityType() {
+        return IacTemplate.class;
+    }
+}