added in tests for bad checksums on ubuntu images, and added in some …

…pydoc docs in the images and volumes sections

added in opensuse checksum and added associated config data

fixed pep8 errors

made some requested changes from PR review

apiclient/harvester_api/managers/images.py

@@ -11,7 +11,8 @@ class ImageManager(BaseManager):
     DOWNLOAD_fmt = "v1/harvester/harvesterhci.io.virtualmachineimages/{ns}/{uid}/download"
     _KIND = "VirtualMachineImage"
 
-    def create_data(self, name, url, desc, stype, namespace, display_name=None, storageclass=None):
+    def create_data(self, name, url, desc, stype, namespace, imageChecksum,
+                    display_name=None, storageclass=None):
         data = {
             "apiVersion": "{API_VERSION}",
             "kind": self._KIND,
@@ -26,6 +27,7 @@ def create_data(self, name, url, desc, stype, namespace, display_name=None, stor
             "spec": {
                 "displayName": display_name or name,
                 "sourceType": stype,
+                "checksum": imageChecksum,
                 "url": url
             }
         }
@@ -38,10 +40,10 @@ def create(self, name, namespace=DEFAULT_NAMESPACE, **kwargs):
         return self._create(self.PATH_fmt.format(uid=name, ns=namespace), **kwargs)
 
     def create_by_url(
-        self, name, url, namespace=DEFAULT_NAMESPACE,
+        self, name, url, imageChecksum, namespace=DEFAULT_NAMESPACE,
         description="", display_name=None, storageclass=None
     ):
-        data = self.create_data(name, url, description, "download", namespace,
+        data = self.create_data(name, url, description, "download", namespace, imageChecksum,
                                 display_name, storageclass)
         return self.create("", namespace, json=data)
 

apiclient/harvester_api/managers/images.pyi

@@ -18,6 +18,7 @@ class ImageManager(BaseManager):
         desc: str,
         stype: str,
         namespace: str,
+        imageChecksum=str,
         display_name: str = ...
     ) -> dict:
         """
@@ -43,6 +44,7 @@ class ImageManager(BaseManager):
         self,
         name: str,
         url: str,
+        imageChecksum: str,
         namespace: str = ...,
         description: str = ...,
         display_name: str = ...

config.yml

@@ -1,5 +1,5 @@
 # Harvester Cluster
-endpoint: 'https://localhost:30443'
+endpoint: 'https://localhost'
 username: 'admin'
 password: 'password1234'
 # Be used to access Harvester node, fill in one of following is enough.
@@ -23,7 +23,13 @@ sleep-timeout: 3
 node-scripts-location: 'scripts/vagrant'
 
 opensuse-image-url: https://download.opensuse.org/repositories/Cloud:/Images:/Leap_15.5/images/openSUSE-Leap-15.5.x86_64-NoCloud.qcow2
+# sha512sum for opensuse image-url
+opensuse-checksum: "2fb54b74f6941882e65125b0bc647d93bccdc1a4ff297a3e7c97896233842720ebd2cad8f0371c8ecfe1e85fd29ad7a6c0e123da69ba41ac9c68630cee5ea23d"
+
 ubuntu-image-url: https://cloud-images.ubuntu.com/releases/releases/22.04/release/ubuntu-22.04-server-cloudimg-amd64.img
+# sha512sum for ubuntu image-url
+ubuntu-checksum: "4ababf3895e65f5731ca1cd45591cd169ff14fd48204ed4262e452e28288500c9355f560da9e5e3fd1f39e14489da2d6eadce20325627003882c5f712dbc0582"
+
 # URL to download all images
 image-cache-url: ''
 

harvester_e2e_tests/conftest.py

@@ -274,6 +274,18 @@ def pytest_addoption(parser):
         default=config_data.get('terraform-provider-rancher'),
         help=('Version of Terraform Rancher Provider')
     )
+    parser.addoption(
+        '--ubuntu-checksum',
+        action='store',
+        default=config_data.get('ubuntu-checksum'),
+        help=('Checksum for ubuntu_image')
+    )
+    parser.addoption(
+        '--opensuse-checksum',
+        action='store',
+        default=config_data.get('opensuse-checksum'),
+        help=('Checksum for opensuse_image')
+    )
 
 
 def pytest_configure(config):

harvester_e2e_tests/fixtures/api_client.py

@@ -70,6 +70,12 @@ def rancher_wait_timeout(request):
     return request.config.getoption("--rancher-cluster-wait-timeout", 1800)
 
 
+@pytest.fixture(scope="session")
+def ubuntu_checksum(request):
+    """Returns Ubuntu checksum from config"""
+    return request.config.getoption("--ubuntu-checksum")
+
+
 @pytest.fixture(scope="session")
 def host_state(request):
     class HostState:

harvester_e2e_tests/fixtures/images.py

@@ -14,6 +14,7 @@
 @pytest.fixture(scope="session")
 def image_opensuse(request, api_client):
     image_server = request.config.getoption("--image-cache-url")
+    checksum = request.config.getoption("--opensuse-checksum")
     url = urlparse(
         request.config.getoption("--opensuse-image-url")
     )
@@ -22,12 +23,13 @@ def image_opensuse(request, api_client):
         *_, image_name = url.path.rsplit("/", 1)
         url = urlparse(urljoin(f"{image_server}/", image_name))
 
-    return ImageInfo(url, name="opensuse", ssh_user="opensuse")
+    return ImageInfo(url, checksum, name="opensuse", ssh_user="opensuse")
 
 
 @pytest.fixture(scope="session")
 def image_ubuntu(request):
     image_server = request.config.getoption("--image-cache-url")
+    checksum = request.config.getoption("--ubuntu-checksum")
     url = urlparse(
         request.config.getoption("--ubuntu-image-url") or DEFAULT_UBUNTU_IMAGE_URL
     )
@@ -36,7 +38,7 @@ def image_ubuntu(request):
         *_, image_name = url.path.rsplit("/", 1)
         url = urlparse(urljoin(f"{image_server}/", image_name))
 
-    return ImageInfo(url, name="ubuntu", ssh_user="ubuntu")
+    return ImageInfo(url, checksum, name="ubuntu", ssh_user="ubuntu")
 
 
 @pytest.fixture(scope="session")
@@ -49,13 +51,14 @@ def image_k3s(request):
 
 
 class ImageInfo:
-    def __init__(self, url_result, name="", ssh_user=None):
+    def __init__(self, url_result, checksum=None, name="", ssh_user=None):
         self.url_result = url_result
         if name:
             self.name = name
         else:
             self.name = self.url.rsplit("/", 1)[-1]
         self.ssh_user = ssh_user
+        self.checksum = checksum
 
     def __repr__(self):
         return f"{__class__.__name__}({self.url_result})"

harvester_e2e_tests/integrations/test_1_images.py

@@ -37,8 +37,8 @@ def fake_invalid_image_file():
         yield Path(f.name)
 
 
-def create_image_url(api_client, name, image_url, wait_timeout):
-    code, data = api_client.images.create_by_url(name, image_url)
+def create_image_url(api_client, name, image_url, checksum, wait_timeout):
+    code, data = api_client.images.create_by_url(name, image_url, checksum)
 
     assert 201 == code, (code, data)
     image_spec = data.get("spec")
@@ -112,6 +112,7 @@ def get_image(api_client, image_name):
 
 @pytest.fixture(scope="class")
 def cluster_network(api_client, vlan_nic):
+    # We should change this at some point. It fails if the total cnet name is over 12 chars
     cnet = f"cnet-{vlan_nic}"
     code, data = api_client.clusternetworks.get(cnet)
     if code != 200:
@@ -266,7 +267,7 @@ def test_create_image_url(self, image_info, unique_name, api_client, wait_timeou
         """
         image_name = f"{image_info.name}-{unique_name}"
         image_url = image_info.url
-        create_image_url(api_client, image_name, image_url, wait_timeout)
+        create_image_url(api_client, image_name, image_url, image_info.checksum, wait_timeout)
 
     @pytest.mark.skip_version_if("> v1.2.0", "<= v1.4.0", reason="Issue#4293 fix after `v1.4.0`")
     @pytest.mark.p0

harvester_e2e_tests/integrations/test_1_volumes.py

@@ -9,9 +9,20 @@
 
 @pytest.fixture(scope="module")
 def ubuntu_image(api_client, unique_name, image_ubuntu, polling_for):
-    image_name = f"img-{unique_name}"
+    """
+    Generates a Ubuntu image
 
-    code, data = api_client.images.create_by_url(image_name, image_ubuntu.url)
+    1. Creates an image name based on unique_name
+    2. Create the image based on URL
+    3. Response for creation should be 201
+    4. Loop while waiting for image to be created
+    5. Yield the image with the namespace and name
+    6. Delete the image
+    7. The response for getting the image name should be 404 after deletion
+    """
+    image_name = f"img-{unique_name}"
+    code, data = api_client.images.create_by_url(image_name, image_ubuntu.url,
+                                                 image_ubuntu.checksum)
     assert 201 == code, f"Fail to create image\n{code}, {data}"
     code, data = polling_for("image do created",
                              lambda c, d: c == 200 and d.get('status', {}).get('progress') == 100,
@@ -30,6 +41,42 @@ def ubuntu_image(api_client, unique_name, image_ubuntu, polling_for):
                     api_client.images.get, image_name)
 
 
+@pytest.fixture(scope="module")
+def ubuntu_image_bad_checksum(api_client, unique_name, image_ubuntu, polling_for):
+    """
+    Generates a Ubuntu image with a bad sha512 checksum
+
+    1. Creates an image name based on unique_name
+    2. Create the image based on URL with a bad statically assigned checksum
+    3. Response for creation should be 201
+    4. Loop while waiting for image to be created
+    5. Yield the image with the namespace and name
+    6. Delete the image
+    7. The response for getting the image name should be 404 after deletion
+    """
+
+    image_name = f"img-{unique_name + '-badchecksum'}"
+    # Random fake checksum to use in test
+    fake_checksum = "241c43e5b63fe2fd8a43a772469f03015\
+                    18bfc42b96ec594f6cc2d6420e7cb4e8a9e7e3ede03c6\
+                    e4c5d1d155d1aa7c0640bc3eefe3d4ccfafbad19db145c86af"
+    code, data = api_client.images.create_by_url(image_name, image_ubuntu.url, fake_checksum)
+    assert 201 == code, f"Fail to create image\n{code}, {data}"
+    code, data = polling_for("image do created",
+                             lambda c, d: c == 200 and d.get('status', {}).get('progress') == 100,
+                             api_client.images.get, image_name)
+    namespace = data['metadata']['namespace']
+    name = data['metadata']['name']
+    yield dict(ssh_user=image_ubuntu.ssh_user, id=f"{namespace}/{name}", display_name=image_name)
+    code, data = api_client.images.get(image_name)
+    if 200 == code:
+        code, data = api_client.images.delete(image_name)
+        assert 200 == code, f"Fail to cleanup image\n{code}, {data}"
+        polling_for("image do deleted",
+                    lambda c, d: 404 == c,
+                    api_client.images.get, image_name)
+
+
 @pytest.fixture(scope="class")
 def ubuntu_vm(api_client, unique_name, ubuntu_image, polling_for):
     vm_name = f"vm-{unique_name}"
@@ -38,6 +85,8 @@ def ubuntu_vm(api_client, unique_name, ubuntu_image, polling_for):
     vm_spec.add_image(vm_name, ubuntu_image["id"])
     code, data = api_client.vms.create(vm_name, vm_spec)
     assert 201 == code, f"Fail to create VM\n{code}, {data}"
+    # This will check to make sure that the status hasn't failed to create
+    assert "True" == data["status"]["conditions"]["status"]
     code, data = polling_for(
         "VM do created",
         lambda c, d: 200 == c and d.get('status', {}).get('printableStatus') == "Running",
@@ -72,6 +121,18 @@ def ubuntu_vm(api_client, unique_name, ubuntu_image, polling_for):
 @pytest.mark.parametrize("create_as", ["json", "yaml"])
 @pytest.mark.parametrize("source_type", ["New", "VM Image"])
 def test_create_volume(api_client, unique_name, ubuntu_image, create_as, source_type, polling_for):
+    """
+    1. Create a volume from image
+    2. Create should respond with 201
+    3. Wait for volume to create
+    4. Failures should be at 0
+    5. Get volume metadata
+    6. Volume should not be in error or transitioning state
+    7. ImageId should match what was used in create
+    8. Delete volume
+    9. Delete volume should reply 404 after delete
+    Ref.
+    """
     image_id, storage_cls = None, None
     if source_type == "VM Image":
         image_id, storage_cls = ubuntu_image['id'], f"longhorn-{ubuntu_image['display_name']}"
@@ -88,6 +149,11 @@ def test_create_volume(api_client, unique_name, ubuntu_image, create_as, source_
     polling_for("volume do created",
                 lambda code, data: 200 == code and data['status']['phase'] == "Bound",
                 api_client.volumes.get, unique_name)
+    code2, data2 = api_client.images.get(ubuntu_image['display_name'])
+    # This grabs the failed count for the image
+    failed: int = data2['status']['failed']
+    # This makes sure that the failures are 0
+    assert 0 == failed, 'Image failed more than 3 times'
 
     code, data = api_client.volumes.get(unique_name)
     mdata, annotations = data['metadata'], data['metadata']['annotations']
@@ -107,6 +173,55 @@ def test_create_volume(api_client, unique_name, ubuntu_image, create_as, source_
                 api_client.volumes.delete, unique_name)
 
 
+@pytest.mark.p1
+@pytest.mark.volumes
+@pytest.mark.parametrize("create_as", ["json", "yaml"])
+@pytest.mark.parametrize("source_type", ["New", "VM Image"])
+def test_create_volume_bad_checksum(api_client, unique_name, ubuntu_image_bad_checksum,
+                                    create_as, source_type, polling_for):
+    """
+    1. Create a volume from image with a bad checksum
+    2. Create should respond with 201
+    3. Wait for volume to create
+    4. Wait for 4 failures in the volume fail status
+    5. Failures should be set at 4
+    6. Delete volume
+    7. Delete volume should reply 404 after delete
+    Ref. https://github.com/harvester/tests/issues/1121
+    """
+    image_id, storage_cls = None, None
+    if source_type == "VM Image":
+        image_id, storage_cls = ubuntu_image_bad_checksum['id'],
+        f"longhorn-{ubuntu_image_bad_checksum['display_name']}"
+
+    spec = api_client.volumes.Spec("10Gi", storage_cls)
+    if create_as == 'yaml':
+        kws = dict(headers={'Content-Type': 'application/yaml'}, json=None,
+                   data=yaml.dump(spec.to_dict(unique_name, 'default', image_id=image_id)))
+    else:
+        kws = dict()
+    code, data = api_client.volumes.create(unique_name, spec, image_id=image_id, **kws)
+    assert 201 == code, (code, unique_name, data, image_id)
+
+    polling_for("volume do created",
+                lambda code, data: 200 == code and data['status']['phase'] == "Bound",
+                api_client.volumes.get, unique_name)
+    code2, data2 = api_client.images.get(ubuntu_image_bad_checksum['display_name'])
+    polling_for("failed to process sync file",
+                lambda code2, data2: 200 == code2 and data2['status']['failed'] == 4,
+                api_client.images.get, ubuntu_image_bad_checksum['display_name'])
+
+    # This grabs the failed count for the image
+    code2, data2 = api_client.images.get(ubuntu_image_bad_checksum['display_name'])
+    failed: int = data2['status']['failed']
+    # This makes sure that the tests fails with bad checksum
+    assert failed == 4, 'Image failed more than 3 times'
+
+    # teardown
+    polling_for("volume do deleted", lambda code, _: 404 == code,
+                api_client.volumes.delete, unique_name)
+
+
 @pytest.mark.p0
 @pytest.mark.volumes
 class TestVolumeWithVM: