implementing registerIacTemplate API

Author: bernardodemarco

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

@@ -16,18 +16,25 @@
 // under the License.
 package org.apache.cloudstack.api.command;
 
+import com.cloud.user.Account;
 import org.apache.cloudstack.acl.RoleType;
 import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiArgValidator;
 import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.ApiErrorCode;
 import org.apache.cloudstack.api.BaseCmd;
 import org.apache.cloudstack.api.Parameter;
+import org.apache.cloudstack.api.ServerApiException;
+import org.apache.cloudstack.api.response.AccountResponse;
 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.context.CallContext;
 import org.apache.cloudstack.persistence.iactemplates.IacTemplate;
 import org.apache.cloudstack.service.NimbleService;
 
 import javax.inject.Inject;
+import java.util.List;
 
 @APICommand(name = "registerIacTemplate",
         description = "Register an IaC template, such as a TOSCA service template.",
@@ -37,43 +44,97 @@ 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)
+    @Parameter(name = ApiConstants.NAME, type = CommandType.STRING,
+            description = "Name of the IaC template.", required = true, validations = {ApiArgValidator.NotNullOrEmpty})
     private String name;
 
-    @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the IaC template.")
+    @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "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)
+    @Parameter(name = ApiConstants.IAC_TEMPLATE_CONTENT, type = CommandType.STRING, length = 65535, 
+            description = "Content of the IaC template.", required = true, validations = {ApiArgValidator.NotNullOrEmpty})
     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.")
+    @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.")
+    @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, 
+            description = "Name of the account that will own 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.")
+    @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, 
+            description = "ID of the project that will own 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_DOMAIN_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = DomainResponse.class,
+            description = "A comma-separated list of domain IDs with which the IaC template will be shared.")
+    private List<Long> sharedDomainIds;
 
-    @Parameter(name = ApiConstants.SHARED_ACCOUNT_IDS, type = CommandType.STRING, description = "")
-    private String sharedAccountIds;
+    @Parameter(name = ApiConstants.SHARED_ACCOUNT_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = AccountResponse.class,
+            description = "A comma-separated list of account IDs with which the IaC template will be shared.")
+    private List<Long> sharedAccountIds;
 
-    @Parameter(name = ApiConstants.SHARED_PROJECT_IDS, type = CommandType.STRING, description = "")
-    private String sharedProjectIds;
+    @Parameter(name = ApiConstants.SHARED_PROJECT_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = ProjectResponse.class,
+            description = "A comma-separated list of project IDs with which the IaC template will be shared.")
+    private List<Long> 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.")
+    @Parameter(name = ApiConstants.RECURSIVE_DOMAINS, type = CommandType.BOOLEAN,
+            description = "Defines whether the IaC template will be shared with the subdomains of the domains specified in the \"shareddomainids\" parameter. Defaults to false.")
     private boolean recursiveDomains = false;
-    
-    @Override
-    public void execute() {
 
+    public String getName() {
+        return name;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public String getIacTemplateContent() {
+        return iacTemplateContent;
+    }
+
+    public Long getDomainId() {
+        return domainId;
+    }
+
+    public String getAccountName() {
+        return accountName;
+    }
+
+    public Long getProjectId() {
+        return projectId;
+    }
+
+    public List<Long> getSharedDomainIds() {
+        return sharedDomainIds;
+    }
+
+    public List<Long> getSharedAccountIds() {
+        return sharedAccountIds;
+    }
+
+    public List<Long> getSharedProjectIds() {
+        return sharedProjectIds;
+    }
+
+    public boolean isRecursiveDomains() {
+        return recursiveDomains;
     }
 
     @Override
     public long getEntityOwnerId() {
-        return 0;
+        Account caller = CallContext.current().getCallingAccount();
+        Account owner = _accountService.finalizeOwner(caller, getAccountName(), getDomainId(), getProjectId());
+        return owner == null ? caller.getAccountId() : owner.getAccountId();
+    }
+
+    @Override
+    public void execute() {
+        IacTemplate iacTemplate = nimbleService.registerIacTemplate(this);
+        if (iacTemplate == null) {
+            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to register IaC template.");
+        }
     }
 }

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

@@ -32,4 +32,8 @@ public IacResourceTypeResponse createIacResourceTypeResponse(IacResourceType iac
         response.setObjectName("iacresourcetypes");
         return response;
     }
+
+    public void createIacTemplateResponse() {
+        
+    }
 }

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

@@ -0,0 +1,22 @@
+// 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;
+
+public interface IacTemplateAccountMapDao extends GenericDao<IacTemplateAccountMapVO, Long> {
+}

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

@@ -0,0 +1,24 @@
+// 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.GenericDaoBase;
+import org.springframework.stereotype.Component;
+
+@Component
+public class IacTemplateAccountMapDaoImpl extends GenericDaoBase<IacTemplateAccountMapVO, Long> implements IacTemplateAccountMapDao {
+}

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

@@ -28,4 +28,9 @@ public class IacTemplateAccountMapVO {
 
     @Column(name = "account_id", nullable = false)
     private long accountId;
+
+    public IacTemplateAccountMapVO(long iacTemplateId, long accountId) {
+        this.iacTemplateId = iacTemplateId;
+        this.accountId = accountId;
+    }
 }

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

@@ -0,0 +1,22 @@
+// 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;
+
+public interface IacTemplateDao extends GenericDao<IacTemplateVO, Long> {
+}

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

@@ -0,0 +1,24 @@
+// 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.GenericDaoBase;
+import org.springframework.stereotype.Component;
+
+@Component
+public class IacTemplateDaoImpl extends GenericDaoBase<IacTemplateVO, Long> implements IacTemplateDao {
+}

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

@@ -0,0 +1,22 @@
+// 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;
+
+public interface IacTemplateDomainMapDao extends GenericDao<IacTemplateDomainMapVO, Long> {
+}

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

@@ -0,0 +1,24 @@
+// 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.GenericDaoBase;
+import org.springframework.stereotype.Component;
+
+@Component
+public class IacTemplateDomainMapDaoImpl extends GenericDaoBase<IacTemplateDomainMapVO, Long> implements IacTemplateDomainMapDao {
+}

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

@@ -28,4 +28,9 @@ public class IacTemplateDomainMapVO {
 
     @Column(name = "domain_id", nullable = false)
     private long domainId;
+
+    public IacTemplateDomainMapVO(long iacTemplateId, long domainId) {
+        this.iacTemplateId = iacTemplateId;
+        this.domainId = domainId;
+    }
 }