/*
Copyright (c) 2016 Red Hat, Inc.
Licensed 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.ovirt.engine.api.v3.adapters;
import static java.util.stream.Collectors.toList;
import static org.ovirt.engine.api.v3.adapters.V3OutAdapters.adaptOut;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.ovirt.engine.api.model.Disk;
import org.ovirt.engine.api.model.DiskAttachment;
import org.ovirt.engine.api.model.Link;
import org.ovirt.engine.api.model.TimeZone;
import org.ovirt.engine.api.model.Vm;
import org.ovirt.engine.api.v3.V3Adapter;
import org.ovirt.engine.api.v3.types.V3CdRoms;
import org.ovirt.engine.api.v3.types.V3CustomProperties;
import org.ovirt.engine.api.v3.types.V3Disk;
import org.ovirt.engine.api.v3.types.V3Disks;
import org.ovirt.engine.api.v3.types.V3Floppies;
import org.ovirt.engine.api.v3.types.V3GuestInfo;
import org.ovirt.engine.api.v3.types.V3KatelloErrata;
import org.ovirt.engine.api.v3.types.V3Link;
import org.ovirt.engine.api.v3.types.V3Nics;
import org.ovirt.engine.api.v3.types.V3Payloads;
import org.ovirt.engine.api.v3.types.V3Permissions;
import org.ovirt.engine.api.v3.types.V3ReportedDevices;
import org.ovirt.engine.api.v3.types.V3Snapshots;
import org.ovirt.engine.api.v3.types.V3Statistics;
import org.ovirt.engine.api.v3.types.V3Status;
import org.ovirt.engine.api.v3.types.V3Tags;
import org.ovirt.engine.api.v3.types.V3VM;
import org.ovirt.engine.api.v3.types.V3WatchDogs;
public class V3VmOutAdapter implements V3Adapter<Vm, V3VM> {
// We will use this string in order to find and fix links to snapshot related actions:
private static final String SNAPSHOT = "snapshot";
// The list of "rels" that should be removed from the set of links created by version 4 of the API, as they are
// new and shouldn't appear in version 3 of the API:
private static final Set<String> RELS_TO_REMOVE = new HashSet<>();
static {
RELS_TO_REMOVE.add("affinitylabels");
RELS_TO_REMOVE.add("diskattachments");
}
@Override
public V3VM adapt(Vm from) {
V3VM to = new V3VM();
// Remove the links for "rels" that are new in version 4 of the API:
if (from.isSetLinks()) {
List<Link> links = from.getLinks().stream()
.filter(link -> !RELS_TO_REMOVE.contains(link.getRel()))
.collect(toList());
to.getLinks().addAll(adaptOut(links));
}
if (from.isSetActions()) {
to.setActions(adaptOut(from.getActions()));
// In version 3 of the API the actions related to snapshots used non standard URL segments, with underscores
// to separate words: preview_snapshot, commit_snapshot and undo_snapshot. In version 4 of the API all the
// URL segments use the same style for URL segments, without underscores, there are no exceptions. So in
// order to keep backwards compatibility we need to add the underscores to the action links generated by
// version 4 of the API.
to.getActions().getLinks().stream()
.filter(this::isSnapshotLink)
.forEach(this::fixSnapshotLink);
}
if (from.isSetBios()) {
to.setBios(adaptOut(from.getBios()));
}
if (from.isSetCdroms()) {
to.setCdroms(new V3CdRoms());
to.getCdroms().getCdRoms().addAll(adaptOut(from.getCdroms().getCdroms()));
}
if (from.isSetCluster()) {
to.setCluster(adaptOut(from.getCluster()));
}
if (from.isSetComment()) {
to.setComment(from.getComment());
}
if (from.isSetConsole()) {
to.setConsole(adaptOut(from.getConsole()));
}
if (from.isSetCpu()) {
to.setCpu(adaptOut(from.getCpu()));
}
if (from.isSetCpuProfile()) {
to.setCpuProfile(adaptOut(from.getCpuProfile()));
}
if (from.isSetCpuShares()) {
to.setCpuShares(from.getCpuShares());
}
if (from.isSetCreationTime()) {
to.setCreationTime(from.getCreationTime());
}
if (from.isSetCustomCpuModel()) {
to.setCustomCpuModel(from.getCustomCpuModel());
}
if (from.isSetCustomEmulatedMachine()) {
to.setCustomEmulatedMachine(from.getCustomEmulatedMachine());
}
if (from.isSetCustomProperties()) {
to.setCustomProperties(new V3CustomProperties());
to.getCustomProperties().getCustomProperty().addAll(adaptOut(from.getCustomProperties().getCustomProperties()));
}
if (from.isSetDeleteProtected()) {
to.setDeleteProtected(from.isDeleteProtected());
}
if (from.isSetDescription()) {
to.setDescription(from.getDescription());
}
if (from.isSetDiskAttachments()) {
V3Disks toDisks = new V3Disks();
for (DiskAttachment fromDiskAttachment : from .getDiskAttachments().getDiskAttachments()) {
Disk fromDisk = fromDiskAttachment.getDisk();
if (fromDisk != null) {
V3Disk toDisk = adaptOut(fromDisk);
toDisks.getDisks().add(toDisk);
}
}
to.setDisks(toDisks);
}
if (from.isSetDisplay()) {
to.setDisplay(adaptOut(from.getDisplay()));
}
if (from.isSetDomain()) {
to.setDomain(adaptOut(from.getDomain()));
}
if (from.isSetExternalHostProvider()) {
to.setExternalHostProvider(adaptOut(from.getExternalHostProvider()));
}
if (from.isSetFloppies()) {
to.setFloppies(new V3Floppies());
to.getFloppies().getFloppies().addAll(adaptOut(from.getFloppies().getFloppies()));
}
if (from.isSetGuestOperatingSystem()) {
to.setGuestOperatingSystem(adaptOut(from.getGuestOperatingSystem()));
}
if (from.isSetGuestTimeZone()) {
to.setGuestTimeZone(adaptOut(from.getGuestTimeZone()));
}
if (from.isSetHighAvailability()) {
to.setHighAvailability(adaptOut(from.getHighAvailability()));
}
if (from.isSetHost()) {
to.setHost(adaptOut(from.getHost()));
}
if (from.isSetId()) {
to.setId(from.getId());
}
if (from.isSetHref()) {
to.setHref(from.getHref());
}
if (from.isSetInitialization()) {
to.setInitialization(adaptOut(from.getInitialization()));
}
if (from.isSetInstanceType()) {
to.setInstanceType(adaptOut(from.getInstanceType()));
}
if (from.isSetIo()) {
to.setIo(adaptOut(from.getIo()));
}
if (from.isSetKatelloErrata()) {
to.setKatelloErrata(new V3KatelloErrata());
to.getKatelloErrata().getKatelloErrata().addAll(adaptOut(from.getKatelloErrata().getKatelloErrata()));
}
if (from.isSetLargeIcon()) {
to.setLargeIcon(adaptOut(from.getLargeIcon()));
}
if (from.isSetMemory()) {
to.setMemory(from.getMemory());
}
if (from.isSetMemoryPolicy()) {
to.setMemoryPolicy(adaptOut(from.getMemoryPolicy()));
}
if (from.isSetMigration()) {
to.setMigration(adaptOut(from.getMigration()));
}
if (from.isSetMigrationDowntime()) {
to.setMigrationDowntime(from.getMigrationDowntime());
}
if (from.isSetName()) {
to.setName(from.getName());
}
if (from.isSetNextRunConfigurationExists()) {
to.setNextRunConfigurationExists(from.isNextRunConfigurationExists());
}
if (from.isSetNics()) {
to.setNics(new V3Nics());
to.getNics().getNics().addAll(adaptOut(from.getNics().getNics()));
}
if (from.isSetNumaTuneMode()) {
to.setNumaTuneMode(from.getNumaTuneMode().value());
}
if (from.isSetOrigin()) {
to.setOrigin(from.getOrigin());
}
if (from.isSetOs()) {
to.setOs(adaptOut(from.getOs()));
}
if (from.isSetPayloads()) {
to.setPayloads(new V3Payloads());
to.getPayloads().getPayload().addAll(adaptOut(from.getPayloads().getPayloads()));
}
if (from.isSetPermissions()) {
to.setPermissions(new V3Permissions());
to.getPermissions().getPermissions().addAll(adaptOut(from.getPermissions().getPermissions()));
}
if (from.isSetPlacementPolicy()) {
to.setPlacementPolicy(adaptOut(from.getPlacementPolicy()));
}
if (from.isSetQuota()) {
to.setQuota(adaptOut(from.getQuota()));
}
if (from.isSetReportedDevices()) {
to.setReportedDevices(new V3ReportedDevices());
to.getReportedDevices().getReportedDevices().addAll(adaptOut(from.getReportedDevices().getReportedDevices()));
}
if (from.isSetRngDevice()) {
to.setRngDevice(adaptOut(from.getRngDevice()));
}
if (from.isSetRunOnce()) {
to.setRunOnce(from.isRunOnce());
}
if (from.isSetSerialNumber()) {
to.setSerialNumber(adaptOut(from.getSerialNumber()));
}
if (from.isSetSmallIcon()) {
to.setSmallIcon(adaptOut(from.getSmallIcon()));
}
if (from.isSetSnapshots()) {
to.setSnapshots(new V3Snapshots());
to.getSnapshots().getSnapshots().addAll(adaptOut(from.getSnapshots().getSnapshots()));
}
if (from.isSetSoundcardEnabled()) {
to.setSoundcardEnabled(from.isSoundcardEnabled());
}
if (from.isSetSso()) {
to.setSso(adaptOut(from.getSso()));
}
if (from.isSetStartPaused()) {
to.setStartPaused(from.isStartPaused());
}
if (from.isSetStartTime()) {
to.setStartTime(from.getStartTime());
}
if (from.isSetStateless()) {
to.setStateless(from.isStateless());
}
if (from.isSetStatistics()) {
to.setStatistics(new V3Statistics());
to.getStatistics().getStatistics().addAll(adaptOut(from.getStatistics().getStatistics()));
}
if (from.isSetStatus()) {
V3Status status = to.getStatus();
if (status == null) {
status = new V3Status();
to.setStatus(status);
}
status.setState(from.getStatus().value());
}
if (from.isSetStatusDetail()) {
V3Status status = to.getStatus();
if (status == null) {
status = new V3Status();
to.setStatus(status);
}
status.setDetail(from.getStatusDetail());
}
if (from.isSetStopReason()) {
to.setStopReason(from.getStopReason());
}
if (from.isSetStopTime()) {
to.setStopTime(from.getStopTime());
}
if (from.isSetStorageDomain()) {
to.setStorageDomain(adaptOut(from.getStorageDomain()));
}
if (from.isSetTags()) {
to.setTags(new V3Tags());
to.getTags().getTags().addAll(adaptOut(from.getTags().getTags()));
}
if (from.isSetTemplate()) {
to.setTemplate(adaptOut(from.getTemplate()));
}
if (from.isSetTimeZone()) {
to.setTimeZone(adaptOut(from.getTimeZone()));
}
if (from.isSetTunnelMigration()) {
to.setTunnelMigration(from.isTunnelMigration());
}
if (from.isSetType()) {
to.setType(from.getType().value());
}
if (from.isSetUsb()) {
to.setUsb(adaptOut(from.getUsb()));
}
if (from.isSetUseLatestTemplateVersion()) {
to.setUseLatestTemplateVersion(from.isUseLatestTemplateVersion());
}
if (from.isSetVirtioScsi()) {
to.setVirtioScsi(adaptOut(from.getVirtioScsi()));
}
if (from.isSetVmPool()) {
to.setVmPool(adaptOut(from.getVmPool()));
}
if (from.isSetWatchdogs()) {
to.setWatchdogs(new V3WatchDogs());
to.getWatchdogs().getWatchDogs().addAll(adaptOut(from.getWatchdogs().getWatchdogs()));
}
// V3 of the API supports a "timezone" element containing a single string, but V4 has replaced that with a
// new structured "time_zone" element containing the name of the time zone and the UTC offset:
if (from.isSetTimeZone() && !to.isSetTimezone()) {
TimeZone timeZone = from.getTimeZone();
if (timeZone.isSetName()) {
to.setTimezone(timeZone.getName());
}
}
// If the V4 virtual machine has a value for the "fqdn" element, then copy it to the V3 "guest_info" element:
if (from.isSetFqdn()) {
V3GuestInfo guestInfo = to.getGuestInfo();
if (guestInfo == null) {
guestInfo = new V3GuestInfo();
to.setGuestInfo(guestInfo);
}
guestInfo.setFqdn(from.getFqdn());
}
return to;
}
/**
* Checks if the given link corresponds to an snapshot action.
*/
private boolean isSnapshotLink(V3Link link) {
return link.isSetRel() && link.getRel().endsWith(SNAPSHOT);
}
/**
* Fixes an snapshot action link, adding the underscore that is used in version 3 of the API.
*/
private void fixSnapshotLink(V3Link link) {
link.setRel(fixSnapshotSegment(link.getRel()));
link.setHref(fixSnapshotSegment(link.getHref()));
}
private String fixSnapshotSegment(String segment) {
if (segment != null && segment.endsWith(SNAPSHOT)) {
segment = segment.substring(0, segment.length() - SNAPSHOT.length()) + "_" + SNAPSHOT;
}
return segment;
}
}