cs-vmware/src/main/java/io/cloudslang/content/vmware/services/DeployOvfTemplateService.java
/*
* Copyright 2019-2024 Open Text
* This program and the accompanying materials
* are made available under the terms of the Apache License v2.0 which accompany this distribution.
*
* The Apache License is available 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 io.cloudslang.content.vmware.services;
import com.vmware.vim25.HttpNfcLeaseDeviceUrl;
import com.vmware.vim25.HttpNfcLeaseInfo;
import com.vmware.vim25.KeyValue;
import com.vmware.vim25.LocalizedMethodFault;
import com.vmware.vim25.ManagedObjectReference;
import com.vmware.vim25.OvfCreateImportSpecParams;
import com.vmware.vim25.OvfCreateImportSpecResult;
import com.vmware.vim25.OvfFileItem;
import com.vmware.vim25.OvfNetworkMapping;
import com.vmware.vim25.RuntimeFaultFaultMsg;
import com.vmware.vim25.ServiceContent;
import com.vmware.vim25.VimPortType;
import io.cloudslang.content.utils.StringUtilities;
import io.cloudslang.content.vmware.connection.ConnectionResources;
import io.cloudslang.content.vmware.entities.AsyncProgressUpdater;
import io.cloudslang.content.vmware.entities.ClusterParameter;
import io.cloudslang.content.vmware.entities.CustomExecutor;
import io.cloudslang.content.vmware.entities.ITransferVmdkFrom;
import io.cloudslang.content.vmware.entities.ManagedObject;
import io.cloudslang.content.vmware.entities.ProgressUpdater;
import io.cloudslang.content.vmware.entities.SyncProgressUpdater;
import io.cloudslang.content.vmware.entities.TransferVmdkFromFile;
import io.cloudslang.content.vmware.entities.TransferVmdkFromInputStream;
import io.cloudslang.content.vmware.entities.TransferVmdkTask;
import io.cloudslang.content.vmware.entities.TransferVmdkToUrl;
import io.cloudslang.content.vmware.entities.VmInputs;
import io.cloudslang.content.vmware.entities.http.HttpInputs;
import io.cloudslang.content.vmware.services.helpers.MorObjectHandler;
import io.cloudslang.content.vmware.services.utils.VmUtils;
import io.cloudslang.content.vmware.utils.OvfUtils;
import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.jetbrains.annotations.NotNull;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import static io.cloudslang.content.vmware.constants.Constants.DISK_DRIVE_CIM_TYPE;
import static io.cloudslang.content.vmware.utils.ConnectionUtils.clearConnectionFromContext;
import static io.cloudslang.content.vmware.utils.OvfUtils.getHttpNfcLeaseErrorState;
import static io.cloudslang.content.vmware.utils.OvfUtils.getHttpNfcLeaseInfo;
import static io.cloudslang.content.vmware.utils.OvfUtils.getHttpNfcLeaseState;
import static io.cloudslang.content.vmware.utils.OvfUtils.isOva;
import static io.cloudslang.content.vmware.utils.OvfUtils.isOvf;
import static java.lang.Thread.sleep;
import static java.nio.charset.StandardCharsets.UTF_8;
public class DeployOvfTemplateService {
private static final String NOT_OVA_OR_OVF = "Template file is not ova or ovf!";
private static final String FAILED_TO_GET_LEASE = "Failed to get a HTTP NFC Lease: ";
private static final String READY = "ready";
private static final String ERROR = "error";
private static final String FILE_COULD_NOT_BE_READ = "Template file could not be read!";
private final CustomExecutor executor;
public DeployOvfTemplateService(final boolean parallel) {
this.executor = new CustomExecutor(parallel);
}
public void deployOvfTemplate(final HttpInputs httpInputs, final VmInputs vmInputs, final String templatePath,
final Map<String, String> ovfNetworkMap, final Map<String, String> ovfPropertyMap)
throws Exception {
final ConnectionResources connectionResources = new ConnectionResources(httpInputs, vmInputs);
try {
final ImmutablePair<ManagedObjectReference, OvfCreateImportSpecResult> pair = createLeaseSetup(connectionResources, vmInputs, templatePath, ovfNetworkMap, ovfPropertyMap);
final ManagedObjectReference httpNfcLease = pair.getLeft();
final OvfCreateImportSpecResult importSpecResult = pair.getRight();
final HttpNfcLeaseInfo httpNfcLeaseInfo = getHttpNfcLeaseInfoWhenReady(connectionResources, httpNfcLease);
final List<HttpNfcLeaseDeviceUrl> deviceUrls = httpNfcLeaseInfo.getDeviceUrl();
final ProgressUpdater progressUpdater = executor.isParallel() ?
new AsyncProgressUpdater(getDisksTotalNoBytes(importSpecResult), httpNfcLease, connectionResources) :
new SyncProgressUpdater(getDisksTotalNoBytes(importSpecResult), httpNfcLease, connectionResources);
executor.execute(progressUpdater);
transferVmdkFiles(templatePath, importSpecResult, deviceUrls, progressUpdater);
executor.shutdown();
} finally {
if (httpInputs.isCloseSession()) {
connectionResources.getConnection().disconnect();
clearConnectionFromContext(httpInputs.getGlobalSessionObject());
}
}
}
protected ImmutablePair<ManagedObjectReference, OvfCreateImportSpecResult> createLeaseSetup(
final ConnectionResources connectionResources, final VmInputs vmInputs, final String templatePath,
final Map<String, String> ovfNetworkMap, final Map<String, String> ovfPropertyMap) throws Exception {
final ManagedObjectReference ovfManager = getOvfManager(connectionResources);
final VmUtils vmUtils = new VmUtils();
final ManagedObjectReference resourcePool;
if (StringUtilities.isBlank(vmInputs.getClusterName())) {
resourcePool = vmUtils.getMorResourcePool(vmInputs.getResourcePool(), connectionResources);
} else {
ManagedObjectReference clusterMor = new MorObjectHandler().getSpecificMor(connectionResources,
connectionResources.getMorRootFolder(), ClusterParameter.CLUSTER_COMPUTE_RESOURCE.getValue(), vmInputs.getClusterName());
resourcePool = vmUtils.getMorResourcePoolFromCluster(connectionResources, clusterMor, vmInputs.getResourcePool());
}
final ManagedObjectReference hostMor = vmUtils.getMorHost(vmInputs.getHostname(), connectionResources, null);
final ManagedObjectReference datastoreMor = vmUtils.getMorDataStore(vmInputs.getDataStore(), connectionResources, null, vmInputs);
final ManagedObjectReference folderMor = vmUtils.getMorFolder(vmInputs.getFolderName(), connectionResources);
final List<OvfNetworkMapping> ovfNetworkMappings = getOvfNetworkMappings(ovfNetworkMap, connectionResources);
final List<KeyValue> ovfPropertyMappings = getOvfPropertyMappings(ovfPropertyMap);
final OvfCreateImportSpecResult importSpecResult = connectionResources.getVimPortType()
.createImportSpec(ovfManager, getOvfTemplateAsString(templatePath), resourcePool, datastoreMor,
getOvfCreateImportSpecParams(vmInputs, hostMor, ovfNetworkMappings, ovfPropertyMappings));
checkImportSpecResultForErrors(importSpecResult);
final ManagedObjectReference httpNfcLease = OvfUtils.getHttpNfcLease(connectionResources,
importSpecResult.getImportSpec(), resourcePool, hostMor, folderMor);
return ImmutablePair.of(httpNfcLease, importSpecResult);
}
private List<KeyValue> getOvfPropertyMappings(final Map<String, String> ovfPropertyMap) {
final List<KeyValue> mappings = new ArrayList<>();
for (Map.Entry<String, String> entry : ovfPropertyMap.entrySet()) {
final KeyValue keyValue = new KeyValue();
keyValue.setKey(entry.getKey());
keyValue.setValue(entry.getValue());
mappings.add(keyValue);
}
return mappings;
}
private List<OvfNetworkMapping> getOvfNetworkMappings(final Map<String, String> ovfNetworkMap,
final ConnectionResources connectionResources)
throws Exception {
final List<OvfNetworkMapping> mappings = new ArrayList<>();
for (Map.Entry<String, String> entry : ovfNetworkMap.entrySet()) {
final OvfNetworkMapping mapping = new OvfNetworkMapping();
mapping.setNetwork(new MorObjectHandler().getSpecificMor(connectionResources, connectionResources.getMorRootFolder(),
ManagedObject.NETWORK.getName(), entry.getValue()));
mapping.setName(entry.getKey());
mappings.add(mapping);
}
return mappings;
}
private void checkImportSpecResultForErrors(OvfCreateImportSpecResult importSpecResult) throws Exception {
if (0 < importSpecResult.getError().size()) {
StringBuilder stringBuilder = new StringBuilder();
for (LocalizedMethodFault fault : importSpecResult.getError()) {
stringBuilder.append(fault.getLocalizedMessage()).append(System.lineSeparator());
}
throw new Exception(stringBuilder.toString());
}
}
private void transferVmdkFiles(final String ovfPath, final OvfCreateImportSpecResult importSpecResult,
final List<HttpNfcLeaseDeviceUrl> deviceUrls, final ProgressUpdater progressUpdater)
throws Exception {
for (HttpNfcLeaseDeviceUrl deviceUrl : deviceUrls) {
final String deviceKey = deviceUrl.getImportKey();
for (OvfFileItem fileItem : importSpecResult.getFileItem()) {
if (deviceKey.equals(fileItem.getDeviceId())) {
final TransferVmdkTask transferVmdkTask = getTransferVmdkTask(ovfPath, progressUpdater, deviceUrl, fileItem);
executor.execute(transferVmdkTask);
break;
}
}
}
}
@NotNull
private TransferVmdkTask getTransferVmdkTask(final String ovfPath, final ProgressUpdater progressUpdater,
final HttpNfcLeaseDeviceUrl deviceUrl, final OvfFileItem fileItem)
throws Exception {
final URL vmDiskUrl = new URL(deviceUrl.getUrl());
final ITransferVmdkFrom transferVmdkFrom = getTransferVmdK(ovfPath, fileItem.getPath());
final TransferVmdkToUrl toUrl = new TransferVmdkToUrl(vmDiskUrl, fileItem.isCreate());
return new TransferVmdkTask(transferVmdkFrom, toUrl, progressUpdater);
}
private ManagedObjectReference getOvfManager(final ConnectionResources connectionResources) throws RuntimeFaultFaultMsg {
final VimPortType vimPort = connectionResources.getVimPortType();
final ManagedObjectReference serviceInstance = connectionResources.getServiceInstance();
final ServiceContent serviceContent = vimPort.retrieveServiceContent(serviceInstance);
return serviceContent.getOvfManager();
}
private ITransferVmdkFrom getTransferVmdK(final String templateFilePathStr, final String vmdkName) throws IOException {
final Path templateFilePath = Paths.get(templateFilePathStr);
if (isOva(templateFilePath)) {
final TarArchiveInputStream tar = new TarArchiveInputStream(new FileInputStream(templateFilePathStr));
TarArchiveEntry entry;
while ((entry = tar.getNextTarEntry()) != null) {
if (new File(entry.getName()).getName().startsWith(vmdkName)) {
return new TransferVmdkFromInputStream(tar, entry.getSize());
}
}
} else if (isOvf(templateFilePath)) {
final Path vmdkPath = templateFilePath.getParent().resolve(vmdkName);
return new TransferVmdkFromFile(vmdkPath.toFile());
}
throw new RuntimeException(NOT_OVA_OR_OVF);
}
@NotNull
private HttpNfcLeaseInfo getHttpNfcLeaseInfoWhenReady(final ConnectionResources connectionResources,
final ManagedObjectReference httpNfcLease) throws Exception {
String leaseState = getHttpNfcLeaseState(connectionResources, httpNfcLease);
while (!READY.equals(leaseState)) {
leaseState = getHttpNfcLeaseState(connectionResources, httpNfcLease);
if (ERROR.equals(leaseState)) {
throw new RuntimeException(FAILED_TO_GET_LEASE + getHttpNfcLeaseErrorState(connectionResources, httpNfcLease));
}
sleep(100);
}
return getHttpNfcLeaseInfo(connectionResources, httpNfcLease);
}
@NotNull
private String getOvfTemplateAsString(final String templatePath) throws IOException {
if (isOva(Paths.get(templatePath))) {
try (final TarArchiveInputStream tar = new TarArchiveInputStream(new FileInputStream(templatePath))) {
TarArchiveEntry entry;
while ((entry = tar.getNextTarEntry()) != null) {
if (isOvf(Paths.get(new File(entry.getName()).getName()))) {
return OvfUtils.writeToString(tar, entry.getSize());
}
}
}
} else if (isOvf(Paths.get(templatePath))) {
final InputStream inputStream = new FileInputStream(templatePath);
return IOUtils.toString(inputStream, UTF_8);
}
throw new RuntimeException(FILE_COULD_NOT_BE_READ);
}
private OvfCreateImportSpecParams getOvfCreateImportSpecParams(final VmInputs vmInputs, final ManagedObjectReference hostSystem,
final List ovfNetworkMappings, final List<KeyValue> ovfPropertyMappings) {
final OvfCreateImportSpecParams params = new OvfCreateImportSpecParams();
params.setHostSystem(hostSystem);
params.setDeploymentOption("");
params.setLocale(String.valueOf(vmInputs.getLocale()));
params.setEntityName(vmInputs.getVirtualMachineName());
params.setIpAllocationPolicy(vmInputs.getIpAllocScheme());
params.setIpProtocol(vmInputs.getIpProtocol());
params.setDiskProvisioning(vmInputs.getDiskProvisioning());
params.getNetworkMapping().addAll(ovfNetworkMappings);
params.getPropertyMapping().addAll(ovfPropertyMappings);
return params;
}
private long getDisksTotalNoBytes(final OvfCreateImportSpecResult importSpecResult) {
long disksTotalNoBytes = 0;
for (final OvfFileItem item : importSpecResult.getFileItem()) {
if (item.getCimType() == DISK_DRIVE_CIM_TYPE) {
disksTotalNoBytes += item.getSize();
}
}
return disksTotalNoBytes;
}
}