def __init__(self, ds_folder=None, ds_file=None):
self.sdk = Sdk()
self.datastore = Datastore()
self.config = Config()
self.ds_folder = ds_folder or ""
self.ds_file = ds_file or ""
self.verify_cert = False
def set_file_from_path_datastore(self, path_datastore): # todo: see if there is a better way to do this (more type safe)
# expected path is [{datastore}] {folder}/{file}
(ds_name, path_file) = path_datastore.split('] ') # split on first instance of ']
(ds_folder, ds_file) = path_file.rsplit('/', 1) # split folder and file
ds_name = ds_name.replace('[', "") # remove leading [
self.datastore = Datastore(name=ds_name)
self.ds_folder = ds_folder
self.ds_file = ds_file
return self
def test_cdrom_iso_add_to_vm(self):
iso_paths = Datastore().files_paths("*.iso")
if len(iso_paths) == 0:
pytest.skip(f"target server did not have an ISO we can use")
iso_path = iso_paths.pop()
assert len(self.vm_device.vm.devices()) == 9
self.vm_device.cdrom_iso_add_to_vm(iso_path)
assert len(self.vm_device.vm.devices()) == 10
cdrom = self.vm_device.vm.devices_Cdroms().pop()
assert cdrom.deviceInfo.label == 'CD/DVD drive 1'
assert cdrom.deviceInfo.summary == f'ISO {iso_path}'
assert cdrom.backing.fileName == iso_path
self.vm_device.remove_device(cdrom)
def test_cdrom_iso_add_to_vm(self):
iso_paths = Datastore().files_paths("*.iso")
if len(iso_paths) == 0:
pytest.skip(f"target server did not have an ISO we can use")
iso_path = iso_paths.pop()
assert len(self.vm_device.vm.devices()) == 9
self.vm_device.cdrom_iso_add_to_vm(iso_path)
assert len(self.vm_device.vm.devices()) == 10
cdrom = self.vm_device.vm.devices_Cdroms().pop()
assert cdrom.deviceInfo.label == 'CD/DVD drive 1'
# the replace calls below are caused by a weird bug of a test difference between running the tests in dev (OSX) and GitHub Actions (Linux)
# where the deviceInfo.summary when executed locally doesn't have the '/' between the datastore name and the path
assert cdrom.deviceInfo.summary.replace('/',' ') == f'ISO {iso_path}'.replace('/',' ')
assert cdrom.backing.fileName.replace('/',' ') == iso_path.replace('/',' ')
self.vm_device.remove_device(cdrom)
def setUp(self):
self.datastore = Datastore()
class test_Datastore(TestCase):
def setUp(self):
self.datastore = Datastore()
def test__init__(self):
assert self.datastore.name == 'datastore1'
def test_datastore(self):
datastore = self.datastore.datastore()
assert datastore.info.name == self.datastore.name
def test_info(self):
info = self.datastore.info()
assert type(info['Capacity']) is str
assert info['Name'] == self.datastore.name
assert type(info['SSD']) is bool
assert type(info['Type']) is str
assert type(info['UUID']) is str
def test_folders(self):
folders = self.datastore.folders()
assert len(folders) > 0
assert set(folders[0]) == {'Owner', 'Modified', 'FolderName', 'Size'}
def test_folders_names(self):
folders = self.datastore.folders_names()
assert len(folders) > 0
def test_search_files(self):
files = self.datastore.files()
assert len(files) > 0
def test_search_files_names(self):
files = self.datastore.files_names()
assert len(files) > 0
def test_search_files_paths(self):
files = self.datastore.files("*")
assert len(files) > 0
def test_folder_create__delete(self):
parent_folder = "an-parent-folder"
folder_name = f"{parent_folder}/random_name_new_folder_{random_string()}"
assert self.datastore.folder_create(
folder_name) == True # create folder
assert self.datastore.folder_delete(
folder_name) == True # delete folder
assert self.datastore.folder_delete(
folder_name) == False # confirm it is not there
assert self.datastore.folder_delete(
parent_folder
) == True # although documentation says that delete is recursive, the parent folder was still here (https://vdc-download.vmware.com/vmwb-repository/dcr-public/b50dcbbf-051d-4204-a3e7-e1b618c1e384/538cf2ec-b34f-4bae-a332-3820ef9e7773/vim.FileManager.html#deleteFile)
assert self.datastore.folder_delete(
parent_folder) == False # confirm parent folder was deleted
class Datastore_File:
def __init__(self, ds_folder=None, ds_file=None):
self.sdk = Sdk()
self.datastore = Datastore()
self.config = Config()
self.ds_folder = ds_folder or ""
self.ds_file = ds_file or ""
self.verify_cert = False
def get_headers(self):
return {'Content-Type': 'application/octet-stream'}
def get_host(self):
return self.config.vsphere_host()
def get_request_cookie(self):
client_cookie = self.sdk.service_instance()._stub.cookie
cookie_name = client_cookie.split("=", 1)[0]
cookie_value = client_cookie.split("=", 1)[1].split(";", 1)[0]
cookie_path = client_cookie.split("=", 1)[1].split(";", 1)[1].split(";", 1)[0].lstrip()
cookie_text = " " + cookie_value + "; $" + cookie_path
cookie = dict()
cookie[cookie_name] = cookie_text
return cookie
def get_params(self):
return {"dsName": self.datastore.name, "dcPath": self.datastore.datacenter}
def get_remote_file(self):
return f"{self.ds_folder}/{self.ds_file}" # todo: add check for when both values are '' (raise exception)
def get_server_url(self):
host = self.get_host()
remote_file = self.get_remote_file()
resource = "/folder/" + remote_file
return "https://" + host + ":443" + resource
def create_path_datastore(self, ds_name, ds_folder, ds_file):
return f"[{ds_name}] {ds_folder}/{ds_file}"
def set_file_from_path_datastore(self, path_datastore): # todo: see if there is a better way to do this (more type safe)
# expected path is [{datastore}] {folder}/{file}
(ds_name, path_file) = path_datastore.split('] ') # split on first instance of ']
(ds_folder, ds_file) = path_file.rsplit('/', 1) # split folder and file
ds_name = ds_name.replace('[', "") # remove leading [
self.datastore = Datastore(name=ds_name)
self.ds_folder = ds_folder
self.ds_file = ds_file
return self
def requests_download_from_url(self):
tmp_file = temp_file(extension=".png")
cookie = self.get_request_cookie()
headers = self.get_headers()
params = self.get_params()
server_url = self.get_server_url()
with open(tmp_file, "wb") as file:
response = requests.get(server_url, params=params, headers=headers, cookies=cookie, verify=self.verify_cert)
file.write(response.content)
return tmp_file
def requests_upload_to_url(self, local_file):
cookie = self.get_request_cookie()
headers = self.get_headers()
params = self.get_params()
server_url = self.get_server_url()
with open(local_file, "rb") as file:
request = requests.put(server_url, params=params, data=file, headers=headers, cookies=cookie, verify=self.verify_cert)
print(request)
print(request.text)
return True
def delete(self):
return self.datastore.file_delete(self.ds_folder, self.ds_file)
def download(self):
return self.requests_download_from_url()
def upload(self, local_file):
return self.requests_upload_to_url(local_file)
# see this PR for a code patch on large file uploads https://github.com/vmware/pyvmomi-community-samples/pull/611/files
# from https://github.com/vmware/pyvmomi-community-samples/blob/83c8bc362d3c3eaec665228618b62a958d0752a7/samples/upload_file_to_datastore.py#L124
# DC: see it the code below helps with large downloads
# This may or may not be useful to the person who writes the download example
# def download(remote_file_path, local_file_path):
# resource = "/folder/%s" % remote_file_path.lstrip("/")
# url = self._get_url(resource)
#
# if sys.version_info >= (2, 6):
# resp = self._do_request(url)
# CHUNK = 16 * 1024
# fd = open(local_file_path, "wb")
# while True:
# chunk = resp.read(CHUNK)
# if not chunk: break
# fd.write(chunk)
# fd.close()
# else:
# urllib.urlretrieve(url, local_file_path)