Compare commits
12
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e235eb96b4 | ||
|
|
46b595e8ba | ||
|
|
24617b7f82 | ||
|
|
06b446934f | ||
|
|
1271218868 | ||
|
|
f943fde994 | ||
|
|
990dfe2f3c | ||
|
|
276276bd9f | ||
|
|
b5c830acfe | ||
|
|
0430ded280 | ||
|
|
3171721b44 | ||
|
|
b5bc04ec83 |
No files matched your search
@@ -0,0 +1,15 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
tags: ["v*"]
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
driver:
|
||||
uses: NAPALM/driver-standard/.gitea/workflows/driver.yml@main
|
||||
with:
|
||||
standard-ref: main
|
||||
secrets:
|
||||
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
|
||||
@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.3.0] - 2026-10-23
|
||||
|
||||
The first release on PyPI.
|
||||
|
||||
### Changed
|
||||
- The driver follows the NAPALM driver standard
|
||||
(https://git.netork.io/NAPALM/driver-standard): CI on Gitea runs ruff, mypy, the
|
||||
tests on Python 3.10–3.13 and at the lowest declared versions, bandit, pip-audit and
|
||||
a build check, and a release tag publishes to PyPI. Python 3.10 remains the floor;
|
||||
requires napalm-device-types 4.21.1.
|
||||
- Provisioning fails, and removes the imported VM, when vSphere hands back fewer
|
||||
network adapters than NICs were asked for, instead of leaving a NIC unconfigured.
|
||||
A failed abort of the import lease is logged at debug level.
|
||||
|
||||
### Added
|
||||
- VM provisioning (`create_vm_from_cloud_init`, `destroy_vm`,
|
||||
`get_vm_status`, `get_network_targets`, `get_image_storages`) from qcow2/raw
|
||||
@@ -15,6 +29,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- `reboot_host` on ESXi, refused outside maintenance mode.
|
||||
- Declares `open-vm-tools` as the guest agent for provisioned VMs.
|
||||
|
||||
### Changed
|
||||
- **Breaking:** `get_device_warnings` is gone; the driver reports facts and the
|
||||
caller names the warnings (netOrk #1111). `get_hypervisor_hosts()` gives each
|
||||
host's connection state (`None` on ESXi, which cannot tell), maintenance mode,
|
||||
configuration issues and managing vCenter (ESXi only); `get_licenses()` gives
|
||||
the assigned licenses with their edition key as `edition`. Requires
|
||||
napalm-device-types 4.14.0; version 0.2.0.
|
||||
- The guest agent is declared per guest OS (`GUEST_AGENTS`, napalm-device-types
|
||||
3.0); VMware provisions Linux guests only and refuses any other `guest_os`.
|
||||
- The NoCloud network-config comes from napalm-device-types
|
||||
(`provisioning.network_config`), which Proxmox uses as well.
|
||||
|
||||
## [0.1.0] - 2026-09-24
|
||||
|
||||
### Added
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# napalm-vmware
|
||||
|
||||
NAPALM drivers for VMware vSphere, speaking the vSphere API through
|
||||
[pyVmomi](https://github.com/vmware/pyvmomi):
|
||||
[pyVmomi](https://pypi.org/project/pyvmomi/):
|
||||
|
||||
| Driver | Endpoint | Device in netOrk |
|
||||
|---|---|---|
|
||||
@@ -29,7 +29,8 @@ hardware**: see [Harvesting fixtures](#harvesting-fixtures).
|
||||
| `get_vm_snapshots`, `create/delete/rollback_vm_snapshot` | ✅ | ✅ | snapshot tree |
|
||||
| `get_vm_storage_pools` | ✅ | ✅ | datastores |
|
||||
| `get_virtual_networks` | ✅ | ✅ (+ dvPortgroups) | port groups |
|
||||
| `get_device_warnings` | ✅ | ✅ | raw `{code, meta}` |
|
||||
| `get_hypervisor_hosts` | ✅ | ✅ | connection state, maintenance mode, config issues, managing vCenter |
|
||||
| `get_licenses` | ✅ | ✅ | license manager: name and edition key, never the key |
|
||||
| `reboot_host` | ✅ (maintenance mode only) | — | `RebootHost_Task` |
|
||||
| `create_vm_from_cloud_init`, `destroy_vm`, `get_vm_status` | ✅ | ✅ | see [Provisioning](#provisioning) |
|
||||
| `get_network_targets`, `get_image_storages` | ✅ | ✅ | port groups, datastores |
|
||||
@@ -56,8 +57,10 @@ Unverified assumptions, to be checked against real hardware:
|
||||
|
||||
## Install
|
||||
|
||||
Python 3.10 or later.
|
||||
|
||||
```bash
|
||||
pip install -e vendor/napalm-device-types/ -e vendor/napalm-vmware/
|
||||
pip install napalm-vmware
|
||||
```
|
||||
|
||||
## Usage
|
||||
@@ -65,8 +68,9 @@ pip install -e vendor/napalm-device-types/ -e vendor/napalm-vmware/
|
||||
```python
|
||||
from napalm_vmware import VmwareEsxiDriver
|
||||
|
||||
driver = VmwareEsxiDriver("esx01.example.lan", "root", "secret",
|
||||
optional_args={"verify_ssl": False})
|
||||
driver = VmwareEsxiDriver(
|
||||
"esx01.example.lan", "root", "secret", optional_args={"verify_ssl": False}
|
||||
)
|
||||
driver.open()
|
||||
print(driver.get_facts())
|
||||
for vm in driver.get_vms():
|
||||
@@ -84,8 +88,11 @@ by two VMs is refused rather than guessed.
|
||||
|
||||
## Tests
|
||||
|
||||
The rules are in [STANDARDS.md](https://git.netork.io/NAPALM/driver-standard/src/branch/main/STANDARDS.md).
|
||||
|
||||
```bash
|
||||
pytest # unit tests, no network
|
||||
python -m venv .venv && .venv/bin/pip install -e ".[dev]"
|
||||
.venv/bin/pytest --cov # unit tests, no network
|
||||
docker run -d --rm -p 127.0.0.1:8989:8989 vmware/vcsim -l 0.0.0.0:8989
|
||||
docker run -d --rm -p 127.0.0.1:8990:8989 vmware/vcsim -esx -l 0.0.0.0:8989
|
||||
VCSIM_VCENTER_PORT=8989 VCSIM_ESXI_PORT=8990 pytest -m vcsim
|
||||
@@ -123,7 +130,9 @@ offers for Proxmox (qcow2/raw):
|
||||
A port group fixes its VLAN, so `get_network_targets` reports each one with
|
||||
`kind="portgroup"`, `vlan_aware=False` and its `fixed_vlan_tag`; a NIC asking
|
||||
for a different `vlan_tag` is refused. The guest agent netOrk installs is
|
||||
`open-vm-tools` (`GUEST_AGENT_PACKAGES`), which reports the IP address back.
|
||||
`open-vm-tools` (`GUEST_AGENTS`), which reports the IP address back. Only
|
||||
Linux guests are provisioned; `guest_os` other than `"linux"` is refused
|
||||
(BSD guests on VMware: NetOrk/netork#801).
|
||||
|
||||
Unverified until #305: that each distribution's cloud kernel carries the
|
||||
PVSCSI and VMXNET3 drivers.
|
||||
@@ -146,5 +155,9 @@ The MoRef is reported alongside as `moref`.
|
||||
hosts. Reporting them on the vCenter would attach their MACs to the wrong
|
||||
device. Add a host with `vmware_esxi` to see its NICs.
|
||||
|
||||
**Warnings are raw.** `get_device_warnings()` returns `{code, meta}` only;
|
||||
what a code means is decided in netOrk's `WARNING_CATALOG`.
|
||||
**Facts, not warnings.** The driver names no warnings. `get_hypervisor_hosts()`
|
||||
and `get_licenses()` report what the endpoint says; whether a host in
|
||||
maintenance mode or the free `esxBasic` edition is a problem is the caller's
|
||||
to decide. The ESXi driver reports `connected` as `None` (a disconnected host
|
||||
could not have answered) and the managing vCenter's address as `managed_by`;
|
||||
under the vCenter driver `managed_by` is `None`, since every host names it.
|
||||
+11
-5
@@ -6,8 +6,10 @@ from pathlib import Path
|
||||
from typing import Any, ClassVar
|
||||
|
||||
from napalm.base.exceptions import ConnectionException
|
||||
from napalm_device_types import HypervisorDriver
|
||||
from napalm_device_types import HypervisorDriver, LicenseMixin
|
||||
from napalm_device_types.models import (
|
||||
HypervisorHostDict,
|
||||
LicenseDict,
|
||||
SnapshotDict,
|
||||
StorageVolumeDict,
|
||||
VirtualNetworkDict,
|
||||
@@ -17,12 +19,13 @@ from napalm_device_types.models import (
|
||||
from napalm_vmware import _session, paths
|
||||
from napalm_vmware._inventory import Inventory
|
||||
from napalm_vmware.parse.environment import environment
|
||||
from napalm_vmware.parse.hosts import hypervisor_hosts
|
||||
from napalm_vmware.parse.licenses import license_list
|
||||
from napalm_vmware.parse.networks import NetworkIndex, network_index, virtual_networks
|
||||
from napalm_vmware.parse.snapshots import snapshot_list
|
||||
from napalm_vmware.parse.storage import storage_pools
|
||||
from napalm_vmware.parse.vm_config import vm_config
|
||||
from napalm_vmware.parse.vms import vm_list
|
||||
from napalm_vmware.parse.warnings import host_warnings
|
||||
from napalm_vmware.provision.image import DEFAULT_CACHE_DIR
|
||||
|
||||
_DEFAULT_PORT = 443
|
||||
@@ -30,7 +33,7 @@ _DEFAULT_PORT = 443
|
||||
_DRIVER_FOR_API = {"HostAgent": "vmware_esxi", "VirtualCenter": "vmware_vcenter"}
|
||||
|
||||
|
||||
class VmwareBaseDriver(HypervisorDriver):
|
||||
class VmwareBaseDriver(LicenseMixin, HypervisorDriver):
|
||||
"""Shared implementation. Concrete drivers set ``API_TYPE`` and ``STANDALONE``."""
|
||||
|
||||
VENDOR = "VMware"
|
||||
@@ -154,5 +157,8 @@ class VmwareBaseDriver(HypervisorDriver):
|
||||
def get_environment(self) -> dict[str, Any]:
|
||||
return environment(self._hosts())
|
||||
|
||||
def get_device_warnings(self) -> list[dict[str, Any]]:
|
||||
return host_warnings(self._hosts(), self._inventory.licenses(), standalone=self.STANDALONE)
|
||||
def get_hypervisor_hosts(self) -> list[HypervisorHostDict]:
|
||||
return hypervisor_hosts(self._hosts(), standalone=self.STANDALONE)
|
||||
|
||||
def get_licenses(self) -> list[LicenseDict]:
|
||||
return license_list(self._inventory.licenses())
|
||||
@@ -0,0 +1,40 @@
|
||||
"""The hosts a driver sees, as facts (``HypervisorDriver.get_hypervisor_hosts``).
|
||||
|
||||
Whether a host in maintenance mode or one managed by a vCenter is a problem is
|
||||
decided by the caller, never here.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
from napalm_device_types.models import HypervisorHostDict
|
||||
|
||||
_CONNECTED = "connected"
|
||||
# Addresses vSphere reports for "no managing vCenter"; data, not a bind.
|
||||
_UNMANAGED = {None, "", "0.0.0.0"} # nosec B104
|
||||
|
||||
|
||||
def _host(host: dict[str, Any], standalone: bool) -> HypervisorHostDict:
|
||||
manager = host.get("summary.managementServerIp")
|
||||
return {
|
||||
"name": host.get("name", host.get("_moref", "")),
|
||||
# A disconnected host could not have answered the ESXi driver.
|
||||
"connected": None
|
||||
if standalone
|
||||
else host.get("runtime.connectionState", _CONNECTED) == _CONNECTED,
|
||||
"maintenance": bool(host.get("runtime.inMaintenanceMode")),
|
||||
"config_issues": [
|
||||
i["fullFormattedMessage"]
|
||||
for i in host.get("configIssue") or []
|
||||
if i.get("fullFormattedMessage")
|
||||
],
|
||||
# Under a vCenter every host names that vCenter; only a host the ESXi
|
||||
# driver reached directly can be managed by someone else.
|
||||
"managed_by": manager if standalone and manager not in _UNMANAGED else None,
|
||||
}
|
||||
|
||||
|
||||
def hypervisor_hosts(hosts: list[dict[str, Any]], *, standalone: bool) -> list[HypervisorHostDict]:
|
||||
"""``standalone`` is True for the ESXi driver, False for vCenter."""
|
||||
return [_host(host, standalone) for host in hosts]
|
||||
@@ -12,7 +12,8 @@ import ipaddress
|
||||
from typing import Any
|
||||
|
||||
_DEFAULT_MTU = 1500
|
||||
_UNASSIGNED = {"", "0.0.0.0"}
|
||||
# Addresses vSphere reports for an interface without one; data, not a bind.
|
||||
_UNASSIGNED = {"", "0.0.0.0"} # nosec B104
|
||||
|
||||
|
||||
def _uplink_mtus(host: dict[str, Any]) -> dict[str, int]:
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
"""Licenses assigned on an endpoint, as facts (``LicenseMixin.get_licenses``).
|
||||
|
||||
The edition key says which edition runs -- ``esxBasic`` is the free vSphere
|
||||
Hypervisor, whose API refuses every write; what follows from that is the
|
||||
caller's to decide. The license key itself is never reported.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
from napalm_device_types.models import LicenseDict
|
||||
|
||||
|
||||
def license_list(licenses: list[dict[str, Any]]) -> list[LicenseDict]:
|
||||
return [
|
||||
{"name": lic.get("name", ""), "status": "active", "edition": str(lic.get("editionKey", ""))}
|
||||
for lic in licenses
|
||||
]
|
||||
@@ -1,53 +0,0 @@
|
||||
"""Raw device warnings: ``{"code", "meta"}`` only.
|
||||
|
||||
What a code means to a user -- severity, wording, the fix -- is decided in
|
||||
netOrk's ``WARNING_CATALOG``, never here.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
_CONNECTED = "connected"
|
||||
_UNMANAGED = {None, "", "0.0.0.0"}
|
||||
#: License edition of the free vSphere Hypervisor. The vSphere API refuses
|
||||
#: every write on it (power, snapshots) with a RestrictedVersion fault.
|
||||
_FREE_EDITIONS = ("esxBasic",)
|
||||
|
||||
|
||||
def _host_codes(host: dict[str, Any], standalone: bool) -> list[dict[str, Any]]:
|
||||
name = host.get("name", host.get("_moref", ""))
|
||||
found: list[dict[str, Any]] = []
|
||||
state = host.get("runtime.connectionState", _CONNECTED)
|
||||
if not standalone and state != _CONNECTED:
|
||||
found.append({"code": "vmware_host_disconnected", "meta": {"host": name, "state": state}})
|
||||
if host.get("runtime.inMaintenanceMode"):
|
||||
found.append({"code": "vmware_host_maintenance_mode", "meta": {"host": name}})
|
||||
issues = [
|
||||
i["fullFormattedMessage"]
|
||||
for i in host.get("configIssue") or []
|
||||
if i.get("fullFormattedMessage")
|
||||
]
|
||||
if issues:
|
||||
found.append({"code": "vmware_host_config_issue", "meta": {"host": name, "issues": issues}})
|
||||
manager = host.get("summary.managementServerIp")
|
||||
if standalone and manager not in _UNMANAGED:
|
||||
found.append({"code": "vmware_host_managed_by_vcenter", "meta": {"vcenter": manager}})
|
||||
return found
|
||||
|
||||
|
||||
def host_warnings(
|
||||
hosts: list[dict[str, Any]], licenses: list[dict[str, Any]], *, standalone: bool
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Warnings for the hosts this driver sees.
|
||||
|
||||
``standalone`` is True for the ESXi driver. It alone reports a host being
|
||||
managed by a vCenter -- a hint to add the vCenter instead -- and it never
|
||||
reports disconnection, since a disconnected host could not have answered.
|
||||
"""
|
||||
found = [w for host in hosts for w in _host_codes(host, standalone)]
|
||||
for lic in licenses:
|
||||
if str(lic.get("editionKey", "")).startswith(_FREE_EDITIONS):
|
||||
found.append({"code": "vmware_api_read_only", "meta": {"edition": lic.get("name", "")}})
|
||||
break
|
||||
return found
|
||||
@@ -12,7 +12,9 @@ import hashlib
|
||||
import json
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
|
||||
# qemu-img is run with a fixed argv and no shell (see below).
|
||||
import subprocess # nosec B404
|
||||
import tempfile
|
||||
from collections.abc import Callable
|
||||
from pathlib import Path
|
||||
@@ -46,7 +48,8 @@ def fetch(url: str, dest: Path, timeout: float) -> None: # pragma: no cover - n
|
||||
|
||||
|
||||
def convert_to_vmdk(src: Path, dst: Path) -> None:
|
||||
subprocess.run(
|
||||
# Fixed argv, no shell: qemu-img from PATH and the cache's own file paths.
|
||||
subprocess.run( # nosec B603
|
||||
[
|
||||
_qemu_img(),
|
||||
"convert",
|
||||
@@ -64,7 +67,8 @@ def convert_to_vmdk(src: Path, dst: Path) -> None:
|
||||
|
||||
def virtual_size(path: Path) -> int:
|
||||
"""The disk size the image describes, in bytes (not the file size)."""
|
||||
out = subprocess.run(
|
||||
# Fixed argv, no shell: qemu-img from PATH and the cache's own file path.
|
||||
out = subprocess.run( # nosec B603
|
||||
[_qemu_img(), "info", "--output", "json", str(path)],
|
||||
check=True,
|
||||
capture_output=True,
|
||||
|
||||
@@ -11,7 +11,8 @@ VMXNET3. Both drivers are in the mainline kernel; whether every distribution's
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from xml.sax.saxutils import escape, quoteattr
|
||||
# Escaping for the descriptor this module writes; no XML is parsed here.
|
||||
from xml.sax.saxutils import escape, quoteattr # nosec B406
|
||||
|
||||
_HW_VERSION = "vmx-13" # ESXi 6.5 and later
|
||||
_GUEST_OS = "otherLinux64Guest"
|
||||
|
||||
@@ -31,20 +31,6 @@ def meta_data(hostname: str, instance_id: str) -> str:
|
||||
return yaml.safe_dump({"instance-id": instance_id, "local-hostname": hostname}, sort_keys=False)
|
||||
|
||||
|
||||
def network_config(nics: list[tuple[str, bool]]) -> dict[str, Any] | None:
|
||||
"""Netplan v2 config: DHCP on every ``(mac, dhcp)`` NIC that asks for it.
|
||||
|
||||
``None`` when no NIC does -- cloud-init then leaves networking alone
|
||||
rather than being told to configure nothing.
|
||||
"""
|
||||
ethernets = {
|
||||
f"nic{i}": {"match": {"macaddress": mac}, "dhcp4": True}
|
||||
for i, (mac, dhcp) in enumerate(nics)
|
||||
if dhcp
|
||||
}
|
||||
return {"version": 2, "ethernets": ethernets} if ethernets else None
|
||||
|
||||
|
||||
def nocloud_iso(user: str, meta: str, network: dict[str, Any] | None) -> bytes:
|
||||
"""An ISO 9660 image (Rock Ridge + Joliet) holding the seed files."""
|
||||
files = {"user-data": user, "meta-data": meta}
|
||||
|
||||
@@ -22,6 +22,7 @@ from napalm_device_types.models import (
|
||||
VMProvisionResultDict,
|
||||
VMStatusDict,
|
||||
)
|
||||
from napalm_device_types.provisioning import GuestAgents, network_config
|
||||
from pyVmomi import vim
|
||||
|
||||
from napalm_vmware import paths
|
||||
@@ -35,7 +36,7 @@ from napalm_vmware.provision.image import ImageCache
|
||||
from napalm_vmware.provision.ovf import ovf_descriptor
|
||||
from napalm_vmware.provision.placement import Inventory as PlacementInventory
|
||||
from napalm_vmware.provision.placement import Placement, choose_placement
|
||||
from napalm_vmware.provision.seed import meta_data, network_config, nocloud_iso, user_data
|
||||
from napalm_vmware.provision.seed import meta_data, nocloud_iso, user_data
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
@@ -48,11 +49,14 @@ _STATUS = {"poweredOn": "running", "poweredOff": "stopped", "suspended": "suspen
|
||||
class VmwareProvisioningMixin:
|
||||
"""Mixed into both drivers ahead of :class:`VmwareBaseDriver`."""
|
||||
|
||||
GUEST_AGENT_PACKAGES: tuple[str, ...] = ("open-vm-tools",)
|
||||
# The unit is open-vm-tools on Debian/Ubuntu and vmtoolsd on EL/Fedora.
|
||||
GUEST_AGENT_RUNCMD: tuple[str, ...] = (
|
||||
"systemctl enable --now open-vm-tools || systemctl enable --now vmtoolsd",
|
||||
)
|
||||
# Linux only: BSD guests on VMware are optional (NetOrk/netork#801). The
|
||||
# unit is open-vm-tools on Debian/Ubuntu and vmtoolsd on EL/Fedora.
|
||||
GUEST_AGENTS: GuestAgents = {
|
||||
"linux": (
|
||||
("open-vm-tools",),
|
||||
("systemctl enable --now open-vm-tools || systemctl enable --now vmtoolsd",),
|
||||
),
|
||||
}
|
||||
|
||||
hostname: str
|
||||
_port: int
|
||||
@@ -148,9 +152,12 @@ class VmwareProvisioningMixin:
|
||||
disk_resize_gb: int | None = None,
|
||||
storage: str | None = None,
|
||||
cpu_type: str | None = None,
|
||||
guest_os: str = "linux",
|
||||
download_timeout: int = 300,
|
||||
timeout: int = 180,
|
||||
) -> VMProvisionResultDict:
|
||||
if guest_os not in self.GUEST_AGENTS:
|
||||
raise ValueError(f"VMware provisions Linux guests only, not {guest_os!r}")
|
||||
if cpu_type is not None:
|
||||
# CPU compatibility is a cluster setting here (EVC), not a per-VM
|
||||
# one, and there is no get_vm_cpu_types() that could offer a model.
|
||||
@@ -245,7 +252,7 @@ class VmwareProvisioningMixin:
|
||||
try:
|
||||
lease.HttpNfcLeaseAbort()
|
||||
except Exception: # noqa: BLE001 - the original error is the one to report
|
||||
pass
|
||||
logger.debug("Aborting the import lease failed: ignored", exc_info=True)
|
||||
raise
|
||||
return info["info"]["entity"]
|
||||
|
||||
@@ -272,13 +279,16 @@ class VmwareProvisioningMixin:
|
||||
changes = _mac_changes(adapters, nics) + _disk_growth(devices, disk_gb, image_size)
|
||||
macs = [
|
||||
(nic.get("mac") or adapter.macAddress or "").lower()
|
||||
for adapter, nic in zip(adapters, nics)
|
||||
for adapter, nic in zip(adapters, nics, strict=True)
|
||||
]
|
||||
seed = nocloud_iso(
|
||||
user,
|
||||
meta_data(name, f"iid-{uuid.uuid4()}"),
|
||||
network_config(
|
||||
[(mac, nic.get("dhcp", i == 0)) for i, (mac, nic) in enumerate(zip(macs, nics))]
|
||||
[
|
||||
(mac, nic.get("dhcp", i == 0))
|
||||
for i, (mac, nic) in enumerate(zip(macs, nics, strict=True))
|
||||
]
|
||||
),
|
||||
)
|
||||
vm_dir = posixpath.dirname(str(props["config.files.vmPathName"]).split("] ", 1)[1])
|
||||
@@ -358,7 +368,7 @@ class VmwareProvisioningMixin:
|
||||
def _mac_changes(adapters: list[Any], nics: list[NICConfigDict]) -> list[Any]:
|
||||
"""Device edits pinning the MACs the caller asked for."""
|
||||
changes = []
|
||||
for adapter, nic in zip(adapters, nics):
|
||||
for adapter, nic in zip(adapters, nics, strict=True):
|
||||
if not nic.get("mac"):
|
||||
continue
|
||||
adapter.addressType = "manual"
|
||||
|
||||
+45
-12
@@ -1,14 +1,14 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=68", "wheel"]
|
||||
requires = ["setuptools>=77"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "napalm-vmware"
|
||||
version = "0.1.0"
|
||||
version = "0.3.0"
|
||||
description = "NAPALM drivers for VMware ESXi hosts and vCenter Server (vSphere API via pyVmomi)"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.10"
|
||||
license = { text = "Apache-2.0" }
|
||||
license = "Apache-2.0"
|
||||
authors = [
|
||||
{ name = "Christian Manivong", email = "christian@manivong.de" },
|
||||
]
|
||||
@@ -17,19 +17,19 @@ classifiers = [
|
||||
"Development Status :: 3 - Alpha",
|
||||
"Intended Audience :: Developers",
|
||||
"Intended Audience :: System Administrators",
|
||||
"License :: OSI Approved :: Apache Software License",
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
"Topic :: System :: Networking",
|
||||
"Topic :: System :: Systems Administration",
|
||||
"Typing :: Typed",
|
||||
]
|
||||
dependencies = [
|
||||
"napalm>=5.0.0",
|
||||
"napalm-device-types>=2.0.0",
|
||||
"napalm-device-types>=4.21.1",
|
||||
"pyvmomi>=8.0.1",
|
||||
# Provisioning: download the image, write the NoCloud seed ISO and its YAML.
|
||||
"requests>=2.31",
|
||||
@@ -39,10 +39,10 @@ dependencies = [
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest",
|
||||
"pytest-cov",
|
||||
"ruff",
|
||||
"mypy",
|
||||
"pytest>=8",
|
||||
"pytest-cov>=5",
|
||||
"mypy>=1.11",
|
||||
"ruff>=0.6",
|
||||
]
|
||||
|
||||
[project.entry-points."napalm.drivers"]
|
||||
@@ -51,6 +51,8 @@ vmware_vcenter = "napalm_vmware:VmwareVcenterDriver"
|
||||
|
||||
[project.urls]
|
||||
Repository = "https://git.netork.io/NAPALM/napalm-vmware"
|
||||
Issues = "https://git.netork.io/NAPALM/napalm-vmware/issues"
|
||||
Changelog = "https://git.netork.io/NAPALM/napalm-vmware/src/branch/main/CHANGELOG.md"
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["."]
|
||||
@@ -69,11 +71,42 @@ markers = [
|
||||
line-length = 100
|
||||
target-version = "py310"
|
||||
|
||||
# Same rule set the netOrk repo gates on.
|
||||
[tool.ruff.lint]
|
||||
select = ["E", "F", "I", "UP"]
|
||||
select = ["E", "F", "I", "UP", "B"]
|
||||
|
||||
[tool.ruff.lint.per-file-ignores]
|
||||
# Recorded device output keeps its lines.
|
||||
"tests/**" = ["E501"]
|
||||
|
||||
[tool.mypy]
|
||||
python_version = "3.10"
|
||||
warn_unused_configs = true
|
||||
strict = true
|
||||
# napalm itself is untyped, so every driver subclasses Any.
|
||||
disallow_subclassing_any = false
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
module = ["napalm.*", "yaml.*"]
|
||||
ignore_missing_imports = true
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
# Not yet under strict mypy (quality baseline); may only shrink.
|
||||
module = [
|
||||
"napalm_vmware._inventory",
|
||||
"napalm_vmware._session",
|
||||
"napalm_vmware._tasks",
|
||||
"napalm_vmware.base",
|
||||
"napalm_vmware.esxi",
|
||||
"napalm_vmware.parse.environment",
|
||||
"napalm_vmware.parse.snapshots",
|
||||
"napalm_vmware.parse.vm_devices",
|
||||
"napalm_vmware.provision.seed",
|
||||
"napalm_vmware.provision.transfer",
|
||||
"napalm_vmware.provisioning",
|
||||
]
|
||||
ignore_errors = true
|
||||
|
||||
[tool.coverage.run]
|
||||
source = ["napalm_vmware"]
|
||||
|
||||
[tool.coverage.report]
|
||||
fail_under = 97
|
||||
@@ -0,0 +1,31 @@
|
||||
{
|
||||
"coverage_floor": 97.0,
|
||||
"function_complexity": {
|
||||
"napalm_vmware/_plain.py::to_plain": 11,
|
||||
"napalm_vmware/base.py::VmwareBaseDriver._find_vm": 12,
|
||||
"napalm_vmware/parse/facts.py::host_serial": 11,
|
||||
"napalm_vmware/parse/interfaces.py::host_interfaces": 11,
|
||||
"napalm_vmware/parse/vms.py::_vm": 13,
|
||||
"napalm_vmware/provision/placement.py::choose_placement": 16
|
||||
},
|
||||
"function_lines": {
|
||||
"napalm_vmware/provision/ovf.py::ovf_descriptor": 80,
|
||||
"napalm_vmware/provisioning.py::VmwareProvisioningMixin._import_ovf": 56,
|
||||
"napalm_vmware/provisioning.py::VmwareProvisioningMixin.create_vm_from_cloud_init": 57
|
||||
},
|
||||
"mypy_relaxed": [
|
||||
"napalm_vmware._inventory",
|
||||
"napalm_vmware._session",
|
||||
"napalm_vmware._tasks",
|
||||
"napalm_vmware.base",
|
||||
"napalm_vmware.esxi",
|
||||
"napalm_vmware.parse.environment",
|
||||
"napalm_vmware.parse.snapshots",
|
||||
"napalm_vmware.parse.vm_devices",
|
||||
"napalm_vmware.provision.seed",
|
||||
"napalm_vmware.provision.transfer",
|
||||
"napalm_vmware.provisioning"
|
||||
],
|
||||
"python_file_lines": {},
|
||||
"untyped_public": []
|
||||
}
|
||||
+25
-5
@@ -72,7 +72,8 @@ class TestIdentity:
|
||||
"rollback_vm_snapshot",
|
||||
"get_vm_storage_pools",
|
||||
"get_virtual_networks",
|
||||
"get_device_warnings",
|
||||
"get_hypervisor_hosts",
|
||||
"get_licenses",
|
||||
],
|
||||
)
|
||||
@pytest.mark.parametrize("cls", DRIVERS)
|
||||
@@ -94,8 +95,14 @@ class TestIdentity:
|
||||
assert callable(getattr(cls, method, None))
|
||||
|
||||
@pytest.mark.parametrize("cls", DRIVERS)
|
||||
def test_declares_its_guest_agent(self, cls):
|
||||
assert cls.GUEST_AGENT_PACKAGES == ("open-vm-tools",)
|
||||
def test_provisions_linux_guests_with_open_vm_tools(self, cls):
|
||||
"""Linux only: BSD guests on VMware are optional (NetOrk/netork#801)."""
|
||||
assert cls.GUEST_AGENTS == {
|
||||
"linux": (
|
||||
("open-vm-tools",),
|
||||
("systemctl enable --now open-vm-tools || systemctl enable --now vmtoolsd",),
|
||||
),
|
||||
}
|
||||
|
||||
|
||||
class TestOptionalArgs:
|
||||
@@ -198,9 +205,22 @@ class TestEsxiGetters:
|
||||
with pytest.raises(RuntimeError, match="no host"):
|
||||
esxi.get_facts()
|
||||
|
||||
def test_warnings(self, esxi, esxi_host):
|
||||
def test_host_facts(self, esxi, esxi_host):
|
||||
esxi_host["runtime.inMaintenanceMode"] = True
|
||||
assert [w["code"] for w in esxi.get_device_warnings()] == ["vmware_host_maintenance_mode"]
|
||||
assert [h["maintenance"] for h in esxi.get_hypervisor_hosts()] == [True]
|
||||
|
||||
def test_license_facts(self, esxi):
|
||||
esxi._inventory.data["licenses"] = [{"editionKey": "esxBasic", "name": "Free"}]
|
||||
assert esxi.get_licenses() == [{"name": "Free", "status": "active", "edition": "esxBasic"}]
|
||||
|
||||
@pytest.mark.parametrize("cls", DRIVERS)
|
||||
def test_no_warnings_of_their_own(self, cls):
|
||||
"""Hosts and licenses are facts; the caller names the warnings (netOrk #1111)."""
|
||||
assert not any(
|
||||
"get_device_warnings" in vars(c)
|
||||
for c in cls.__mro__
|
||||
if c.__module__.startswith("napalm_vmware")
|
||||
)
|
||||
|
||||
def test_storage_and_networks(self, esxi):
|
||||
assert list(esxi.get_vm_storage_pools())
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
"""Datastores, sensors/utilisation, CDP/LLDP neighbours and raw device warnings."""
|
||||
"""Datastores, sensors/utilisation, CDP/LLDP neighbours, host and license facts."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import pytest
|
||||
|
||||
from napalm_vmware.parse.environment import environment
|
||||
from napalm_vmware.parse.hosts import hypervisor_hosts
|
||||
from napalm_vmware.parse.licenses import license_list
|
||||
from napalm_vmware.parse.lldp import lldp_neighbors
|
||||
from napalm_vmware.parse.storage import storage_pools
|
||||
from napalm_vmware.parse.warnings import host_warnings
|
||||
|
||||
|
||||
class TestStoragePools:
|
||||
@@ -125,60 +126,76 @@ class TestLldpNeighbors:
|
||||
assert lldp_neighbors([]) == {}
|
||||
|
||||
|
||||
class TestHostWarnings:
|
||||
class TestHypervisorHosts:
|
||||
"""Facts only (netOrk #1111): which of them is a warning is the caller's call."""
|
||||
|
||||
def test_healthy_vcsim_host(self, esxi_host):
|
||||
assert host_warnings([esxi_host], [], standalone=True) == []
|
||||
assert hypervisor_hosts([esxi_host], standalone=True) == [
|
||||
{
|
||||
"name": "localhost.localdomain",
|
||||
"connected": None,
|
||||
"maintenance": False,
|
||||
"config_issues": [],
|
||||
"managed_by": None,
|
||||
}
|
||||
]
|
||||
|
||||
def test_maintenance_mode(self, esxi_host):
|
||||
esxi_host["runtime.inMaintenanceMode"] = True
|
||||
assert host_warnings([esxi_host], [], standalone=True) == [
|
||||
{"code": "vmware_host_maintenance_mode", "meta": {"host": "localhost.localdomain"}}
|
||||
]
|
||||
assert hypervisor_hosts([esxi_host], standalone=True)[0]["maintenance"] is True
|
||||
|
||||
@pytest.mark.parametrize("state", ["disconnected", "notResponding"])
|
||||
def test_disconnected_host_under_vcenter(self, esxi_host, state):
|
||||
esxi_host["runtime.connectionState"] = state
|
||||
assert host_warnings([esxi_host], [], standalone=False) == [
|
||||
{
|
||||
"code": "vmware_host_disconnected",
|
||||
"meta": {"host": "localhost.localdomain", "state": state},
|
||||
}
|
||||
]
|
||||
assert hypervisor_hosts([esxi_host], standalone=False)[0]["connected"] is False
|
||||
|
||||
def test_connected_host_under_vcenter(self, esxi_host):
|
||||
assert hypervisor_hosts([esxi_host], standalone=False)[0]["connected"] is True
|
||||
|
||||
def test_a_standalone_host_cannot_tell(self, esxi_host):
|
||||
"""A disconnected host could not have answered the ESXi driver."""
|
||||
esxi_host["runtime.connectionState"] = "disconnected"
|
||||
assert hypervisor_hosts([esxi_host], standalone=True)[0]["connected"] is None
|
||||
|
||||
def test_config_issues(self, esxi_host):
|
||||
esxi_host["configIssue"] = [
|
||||
{"fullFormattedMessage": "SSH for the host has been enabled"},
|
||||
{"fullFormattedMessage": ""},
|
||||
]
|
||||
assert host_warnings([esxi_host], [], standalone=True) == [
|
||||
{
|
||||
"code": "vmware_host_config_issue",
|
||||
"meta": {
|
||||
"host": "localhost.localdomain",
|
||||
"issues": ["SSH for the host has been enabled"],
|
||||
},
|
||||
}
|
||||
assert hypervisor_hosts([esxi_host], standalone=True)[0]["config_issues"] == [
|
||||
"SSH for the host has been enabled"
|
||||
]
|
||||
|
||||
def test_standalone_driver_on_a_vcenter_managed_host(self, esxi_host):
|
||||
esxi_host["summary.managementServerIp"] = "192.0.2.5"
|
||||
assert host_warnings([esxi_host], [], standalone=True) == [
|
||||
{"code": "vmware_host_managed_by_vcenter", "meta": {"vcenter": "192.0.2.5"}}
|
||||
]
|
||||
assert hypervisor_hosts([esxi_host], standalone=True)[0]["managed_by"] == "192.0.2.5"
|
||||
|
||||
@pytest.mark.parametrize("ip", ["", "0.0.0.0", None])
|
||||
def test_unmanaged(self, esxi_host, ip):
|
||||
esxi_host["summary.managementServerIp"] = ip
|
||||
assert hypervisor_hosts([esxi_host], standalone=True)[0]["managed_by"] is None
|
||||
|
||||
def test_vcenter_driver_does_not_report_its_own_management(self, esxi_host):
|
||||
esxi_host["summary.managementServerIp"] = "192.0.2.5"
|
||||
assert host_warnings([esxi_host], [], standalone=False) == []
|
||||
assert hypervisor_hosts([esxi_host], standalone=False)[0]["managed_by"] is None
|
||||
|
||||
def test_free_license_makes_the_api_read_only(self, esxi_host):
|
||||
licenses = [{"editionKey": "esxBasic", "name": "VMware vSphere 8 Hypervisor"}]
|
||||
assert host_warnings([esxi_host], licenses, standalone=True) == [
|
||||
|
||||
class TestLicenseList:
|
||||
def test_the_edition_key_is_the_edition(self):
|
||||
licenses = [
|
||||
{
|
||||
"code": "vmware_api_read_only",
|
||||
"meta": {"edition": "VMware vSphere 8 Hypervisor"},
|
||||
"editionKey": "esxBasic",
|
||||
"name": "VMware vSphere 8 Hypervisor",
|
||||
"licenseKey": "AAAAA-BBBBB-CCCCC-DDDDD-EEEEE",
|
||||
}
|
||||
]
|
||||
assert license_list(licenses) == [
|
||||
{"name": "VMware vSphere 8 Hypervisor", "status": "active", "edition": "esxBasic"}
|
||||
]
|
||||
|
||||
def test_evaluation_license_is_not_read_only(self, esxi_host):
|
||||
licenses = [{"editionKey": "eval", "name": "Evaluation Mode"}]
|
||||
assert host_warnings([esxi_host], licenses, standalone=True) == []
|
||||
def test_the_key_is_never_reported(self):
|
||||
licenses = [{"editionKey": "eval", "name": "Evaluation Mode", "licenseKey": "00000"}]
|
||||
assert "00000" not in str(license_list(licenses))
|
||||
|
||||
def test_none(self):
|
||||
assert license_list([]) == []
|
||||
@@ -6,8 +6,11 @@ import io
|
||||
|
||||
import pycdlib
|
||||
import yaml
|
||||
from napalm_device_types import provisioning as generic
|
||||
|
||||
from napalm_vmware.provision.seed import meta_data, network_config, nocloud_iso, user_data
|
||||
from napalm_vmware import provisioning as prov
|
||||
from napalm_vmware.provision import seed
|
||||
from napalm_vmware.provision.seed import meta_data, nocloud_iso, user_data
|
||||
|
||||
|
||||
class TestUserData:
|
||||
@@ -34,17 +37,13 @@ def test_meta_data():
|
||||
|
||||
|
||||
class TestNetworkConfig:
|
||||
def test_dhcp_nics_matched_by_mac(self):
|
||||
cfg = network_config([("00:50:56:aa:bb:cc", True), ("00:50:56:aa:bb:dd", False)])
|
||||
assert cfg == {
|
||||
"version": 2,
|
||||
"ethernets": {
|
||||
"nic0": {"match": {"macaddress": "00:50:56:aa:bb:cc"}, "dhcp4": True},
|
||||
},
|
||||
}
|
||||
"""Written by napalm-device-types, which Proxmox uses as well (NetOrk/netork#794)."""
|
||||
|
||||
def test_no_dhcp_nic_means_no_network_config(self):
|
||||
assert network_config([("00:50:56:aa:bb:cc", False)]) is None
|
||||
def test_the_seed_is_built_with_the_generic_network_config(self):
|
||||
assert prov.network_config is generic.network_config
|
||||
|
||||
def test_no_copy_of_it_is_left_here(self):
|
||||
assert not hasattr(seed, "network_config")
|
||||
|
||||
|
||||
def _read(iso: bytes, name: str) -> str:
|
||||
|
||||
@@ -152,6 +152,18 @@ class TestCreate:
|
||||
staged.cache.return_value.vmdk.assert_not_called()
|
||||
staged.import_ovf.assert_not_called()
|
||||
|
||||
@pytest.mark.parametrize("guest_os", ["freebsd", "openbsd"])
|
||||
def test_a_guest_other_than_linux_is_refused_before_anything_happens(
|
||||
self, driver, staged, guest_os
|
||||
):
|
||||
with pytest.raises(ValueError, match=guest_os):
|
||||
_create(driver, guest_os=guest_os)
|
||||
staged.cache.return_value.vmdk.assert_not_called()
|
||||
staged.import_ovf.assert_not_called()
|
||||
|
||||
def test_linux_is_the_default_guest(self, driver, staged):
|
||||
assert _create(driver, guest_os="linux")["vmid"] == "uuid-99"
|
||||
|
||||
def test_placement_refusal_is_a_runtime_error(self, driver, staged):
|
||||
with patch.object(prov, "choose_placement", side_effect=ValueError("no host")):
|
||||
with pytest.raises(RuntimeError, match="no host"):
|
||||
@@ -246,6 +258,13 @@ class TestFinishVm:
|
||||
_, spec = self._finish(driver, esxi_data, [{"bridge": "VM Network"}], disk_gb=1)
|
||||
assert not any(type(c.device).__name__.endswith("VirtualDisk") for c in spec.deviceChange)
|
||||
|
||||
def test_a_vm_without_an_adapter_per_requested_nic_is_refused(self, driver, esxi_data):
|
||||
# The OVF asks for one adapter per NIC; a VM that came back with fewer would
|
||||
# get a seed that leaves a NIC unconfigured. create_vm_from_cloud_init
|
||||
# discards it on any error from here.
|
||||
with pytest.raises(ValueError):
|
||||
self._finish(driver, esxi_data, [{"bridge": "VM Network"}, {"bridge": "VM Network"}])
|
||||
|
||||
|
||||
class TestDestroyAndStatus:
|
||||
def test_destroy_powers_off_first(self, driver, esxi_data):
|
||||
|
||||
+2
-1
@@ -50,7 +50,8 @@ def test_esxi_reads(esxi):
|
||||
assert esxi.get_vm_storage_pools()
|
||||
assert esxi.get_virtual_networks()
|
||||
assert "cpu" in esxi.get_environment()
|
||||
assert isinstance(esxi.get_device_warnings(), list)
|
||||
assert isinstance(esxi.get_hypervisor_hosts(), list)
|
||||
assert isinstance(esxi.get_licenses(), list)
|
||||
assert isinstance(esxi.get_lldp_neighbors(), dict)
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user