ipsecondary_test.py

#!/usr/bin/env python3

import argparse
import logging
import time

from os import getcwd, chdir, path

from test_fixtures import with_aktualizr, with_uptane_backend, KeyStore, with_secondary, with_treehub,\
    with_sysroot, with_director, TestRunner, IPSecondary

logger = logging.getLogger("IPSecondaryTest")


# The following is a test suit intended for IP Secondary integration testing
@with_uptane_backend()
@with_secondary(start=True)
@with_aktualizr(start=False, output_logs=False)
def test_secondary_update_if_secondary_starts_first(uptane_repo, secondary, aktualizr, **kwargs):
    '''Test Secondary update if Secondary is booted before Primary'''

    # add a new image to the repo in order to update the Secondary with it
    secondary_image_filename = "secondary_image_filename_001.img"
    secondary_image_hash = uptane_repo.add_image(id=secondary.id, image_filename=secondary_image_filename)

    logger.debug("Trying to update ECU {} with the image {}".
                format(secondary.id, (secondary_image_hash, secondary_image_filename)))

    with aktualizr:
        # run aktualizr once, Secondary has been already running
        aktualizr.wait_for_completion()

    test_result = secondary_image_hash == aktualizr.get_current_image_info(secondary.id)
    logger.debug("Update result: {}".format("success" if test_result else "failed"))
    return test_result


@with_uptane_backend()
@with_secondary(start=False)
@with_aktualizr(start=True, output_logs=False)
def test_secondary_update_if_primary_starts_first(uptane_repo, secondary, aktualizr, **kwargs):
    '''Test Secondary update if Secondary is booted after Primary'''

    # add a new image to the repo in order to update the Secondary with it
    secondary_image_filename = "secondary_image_filename_001.img"
    secondary_image_hash = uptane_repo.add_image(id=secondary.id, image_filename=secondary_image_filename)

    logger.debug("Trying to update ECU {} with the image {}".
                format(secondary.id, (secondary_image_hash, secondary_image_filename)))
    with secondary:
        # start Secondary, aktualizr has been already started in 'once' mode
        aktualizr.wait_for_completion()

    test_result = secondary_image_hash == aktualizr.get_current_image_info(secondary.id)
    logger.debug("Update result: {}".format("success" if test_result else "failed"))
    return test_result


@with_uptane_backend()
@with_director()
@with_secondary(start=False, output_logs=True)
@with_aktualizr(start=False, output_logs=True)
def test_secondary_update(uptane_repo, secondary, aktualizr, director, **kwargs):
    '''Test Secondary update if a boot order of Secondary and Primary is undefined'''

    # add a new image to the repo in order to update the Secondary with it
    secondary_image_filename = "secondary_image_filename.img"
    secondary_image_hash = uptane_repo.add_image(id=secondary.id, image_filename=secondary_image_filename)

    logger.debug("Trying to update ECU {} with the image {}".
                format(secondary.id, (secondary_image_hash, secondary_image_filename)))

    # start Secondary and aktualizr processes, aktualizr is started in 'once' mode
    with secondary, aktualizr:
        aktualizr.wait_for_completion()

    if not director.get_install_result():
        logger.error("Installation result is not successful")
        return False

    # check currently installed hash
    if secondary_image_hash != aktualizr.get_current_image_info(secondary.id):
        logger.error("Target image hash doesn't match the currently installed hash")
        return False

    # check updated file
    update_file = path.join(secondary.storage_dir.name, "firmware.txt")
    if not path.exists(update_file):
        logger.error("Expected updated file does not exist: {}".format(update_file))
        return False

    if secondary_image_filename != director.get_ecu_manifest_filepath(secondary.id[1]):
        logger.error("Target name doesn't match a filepath value of the reported manifest: {}".format(director.get_manifest()))
        return False

    return True


@with_uptane_backend()
@with_secondary(start=True, id=('hwid1', 'serial1'), output_logs=False)
@with_aktualizr(start=False, output_logs=True)
def test_add_secondary(uptane_repo, secondary, aktualizr, **kwargs):
    '''Test adding a Secondary after registration'''

    with aktualizr:
        aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id):
        logger.error("Secondary ECU is not registered.")
        return False

    with IPSecondary(output_logs=False, id=('hwid1', 'serial2')) as secondary2:
        # Why is this necessary? The Primary waiting works outside of this test.
        time.sleep(5)
        aktualizr.add_secondary(secondary2)
        with aktualizr:
            aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary2.id):
        logger.error("Secondary ECU is not registered.")
        return False

    return True


@with_uptane_backend()
@with_secondary(start=True, id=('hwid1', 'serial1'), output_logs=False)
@with_secondary(start=True, id=('hwid1', 'serial2'), output_logs=False, arg_name='secondary2')
@with_aktualizr(start=False, output_logs=True)
def test_remove_secondary(uptane_repo, secondary, secondary2, aktualizr, **kwargs):
    '''Test removing a Secondary after registration'''

    with aktualizr:
        aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary2.id):
        logger.error("Secondary ECU is not registered.")
        return False

    aktualizr.remove_secondary(secondary2)
    with aktualizr:
        aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id):
        logger.error("Secondary ECU is not registered.")
        return False
    if aktualizr.is_ecu_registered(secondary2.id):
        logger.error("Secondary ECU is unexpectedly still registered.")
        return False

    return True


@with_uptane_backend()
@with_secondary(start=True, id=('hwid1', 'serial1'), output_logs=False)
@with_secondary(start=True, id=('hwid1', 'serial2'), output_logs=False, arg_name='secondary2')
@with_aktualizr(start=False, output_logs=True)
def test_replace_secondary(uptane_repo, secondary, secondary2, aktualizr, **kwargs):
    '''Test replacing a Secondary after registration'''

    with aktualizr:
        aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary2.id):
        logger.error("Secondary ECU is not registered.")
        return False

    aktualizr.remove_secondary(secondary2)

    with IPSecondary(output_logs=False, id=('hwid1', 'serial3')) as secondary3:
        # Why is this necessary? The Primary waiting works outside of this test.
        time.sleep(5)
        aktualizr.add_secondary(secondary3)
        with aktualizr:
            aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary3.id):
        logger.error("Secondary ECU is not registered.")
        return False
    if aktualizr.is_ecu_registered(secondary2.id):
        logger.error("Secondary ECU is unexpectedly still registered.")
        return False

    return True


@with_uptane_backend()
@with_secondary(start=True, id=('hwid1', 'serial1'), output_logs=False)
@with_aktualizr(start=False, output_logs=True)
def test_replace_secondary_same_port(uptane_repo, secondary, aktualizr, **kwargs):
    '''Test replacing a Secondary that reuses the same port'''

    port = IPSecondary.get_free_port()
    with IPSecondary(output_logs=False, id=('hwid1', 'serial2'), port=port) as secondary2:
        # Why is this necessary? The Primary waiting works outside of this test.
        time.sleep(5)
        aktualizr.add_secondary(secondary2)
        with aktualizr:
            aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary2.id):
        logger.error("Secondary ECU is not registered.")
        return False

    aktualizr.remove_secondary(secondary2)

    with IPSecondary(output_logs=False, id=('hwid1', 'serial3'), port=port) as secondary3:
        # Why is this necessary? The Primary waiting works outside of this test.
        time.sleep(5)
        aktualizr.add_secondary(secondary3)
        with aktualizr:
            aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary3.id):
        logger.error("Secondary ECU is not registered.")
        return False
    if aktualizr.is_ecu_registered(secondary2.id):
        logger.error("Secondary ECU is unexpectedly still registered.")
        return False

    return True


@with_uptane_backend()
@with_secondary(start=True, id=('hwid1', 'serial1'), output_logs=False)
@with_aktualizr(start=False, output_logs=True)
def test_change_secondary_port(uptane_repo, secondary, aktualizr, **kwargs):
    '''Test changing a Secondary's port but not the ECU serial'''

    with IPSecondary(output_logs=False, id=('hwid1', 'serial2')) as secondary2:
        # Why is this necessary? The Primary waiting works outside of this test.
        time.sleep(5)
        aktualizr.add_secondary(secondary2)
        with aktualizr:
            aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary2.id):
        logger.error("Secondary ECU is not registered.")
        return False

    aktualizr.remove_secondary(secondary2)

    with IPSecondary(output_logs=False, id=('hwid1', 'serial2')) as secondary3:
        # Why is this necessary? The Primary waiting works outside of this test.
        time.sleep(5)
        aktualizr.add_secondary(secondary3)
        with aktualizr:
            aktualizr.wait_for_completion()

    if secondary2.port == secondary3.port:
        logger.error("Secondary ECU port unexpectedly did not change!")
        return False

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary3.id):
        logger.error("Secondary ECU is not registered.")
        return False

    return True


@with_treehub()
@with_uptane_backend()
@with_director()
@with_sysroot()
@with_secondary(start=False, output_logs=True)
@with_aktualizr(start=False, run_mode='once', output_logs=True)
def test_secondary_ostree_update(uptane_repo, secondary, aktualizr, treehub, sysroot, director, **kwargs):
    """Test Secondary OSTree update if a boot order of Secondary and Primary is undefined"""

    target_rev = treehub.revision
    expected_targetname = uptane_repo.add_ostree_target(secondary.id, target_rev, "GARAGE_TARGET_NAME")

    with secondary:
        with aktualizr:
            aktualizr.wait_for_completion()

    pending_rev = aktualizr.get_current_pending_image_info(secondary.id)

    if pending_rev != target_rev:
        logger.error("Pending version {} != the target one {}".format(pending_rev, target_rev))
        return False

    sysroot.update_revision(pending_rev)
    secondary.emulate_reboot()

    aktualizr.set_mode('full')
    with aktualizr:
        with secondary:
            director.wait_for_install()

    if not director.get_install_result():
        logger.error("Installation result is not successful")
        return False

    installed_rev = aktualizr.get_current_image_info(secondary.id)

    if installed_rev != target_rev:
        logger.error("Installed version {} != the target one {}".format(installed_rev, target_rev))
        return False

    if expected_targetname != director.get_ecu_manifest_filepath(secondary.id[1]):
        logger.error(
            "Target name doesn't match a filepath value of the reported manifest: expected: {}, actual: {}".
            format(expected_targetname, director.get_ecu_manifest_filepath(secondary.id[1])))
        return False

    return True


@with_treehub()
@with_uptane_backend()
@with_director()
@with_sysroot()
@with_secondary(start=False, output_logs=False, force_reboot=True)
@with_aktualizr(start=False, run_mode='once', output_logs=True)
def test_secondary_ostree_reboot(uptane_repo, secondary, aktualizr, treehub, sysroot, director, **kwargs):
    target_rev = treehub.revision
    uptane_repo.add_ostree_target(secondary.id, target_rev, "GARAGE_TARGET_NAME")

    with secondary:
        with aktualizr:
            aktualizr.wait_for_completion()
        secondary.wait_for_completion()

    pending_rev = aktualizr.get_current_pending_image_info(secondary.id)

    if pending_rev != target_rev:
        logger.error("Pending version {} != the target one {}".format(pending_rev, target_rev))
        return False

    sysroot.update_revision(pending_rev)

    aktualizr.set_mode('full')
    with secondary:
        # Why is this necessary? The Primary waiting works outside of this test.
        time.sleep(5)
        with aktualizr:
            director.wait_for_install()

    if not director.get_install_result():
        logger.error("Installation result is not successful")
        return False

    installed_rev = aktualizr.get_current_image_info(secondary.id)

    if installed_rev != target_rev:
        logger.error("Installed version {} != the target one {}".format(installed_rev, target_rev))
        return False

    return True


@with_uptane_backend()
@with_director()
@with_secondary(start=False)
@with_aktualizr(start=False, secondary_wait_sec=1, output_logs=False)
def test_secondary_install_timeout(uptane_repo, secondary, aktualizr, director, **kwargs):
    '''Test that secondary install fails after a timeout if the secondary never connects'''

    # run aktualizr and secondary and wait until the device/aktualizr is registered
    with aktualizr, secondary:
        aktualizr.wait_for_completion()

    # the secondary must be registered
    if not aktualizr.is_ecu_registered(secondary.id):
        return False

    # make sure that the secondary is not running
    if secondary.is_running():
        return False

    # launch an update on secondary without it
    secondary_image_filename = "secondary_image_filename_001.img"
    uptane_repo.add_image(id=secondary.id, image_filename=secondary_image_filename)

    aktualizr.update_wait_timeout(0.1)
    with aktualizr:
        aktualizr.wait_for_completion()

    manifest = director.get_manifest()
    result_code = manifest["signed"]["installation_report"]["report"]["result"]["code"]
    if result_code != "INTERNAL_ERROR":
        logger.error("Wrong result code {}".format(result_code))
        return False

    return not director.get_install_result()


@with_uptane_backend()
@with_secondary(start=False)
@with_aktualizr(start=False, output_logs=False, wait_timeout=0.1)
def test_primary_timeout_during_first_run(uptane_repo, secondary, aktualizr, **kwargs):
    """Test Aktualizr's timeout of waiting for Secondaries during initial boot"""

    secondary_image_filename = "secondary_image_filename_001.img"
    uptane_repo.add_image(id=secondary.id, image_filename=secondary_image_filename)

    logger.debug("Checking Aktualizr behaviour if it timeouts while waiting for a connection from the secondary")

    # just start the aktualizr and expect that it timeouts on waiting for a connection from the Secondary
    # so the Secondary is not registered at the device and backend
    with aktualizr:
        aktualizr.wait_for_completion()

    info = aktualizr.get_info()
    if info is None:
        return False
    not_provisioned = 'Provisioned on server: no' in info

    return not_provisioned and not aktualizr.is_ecu_registered(secondary.id)


@with_uptane_backend()
@with_director()
@with_secondary(start=False)
@with_aktualizr(start=False, output_logs=True)
def test_primary_wait_secondary_install(uptane_repo, secondary, aktualizr, director, **kwargs):
    """Test that Primary waits for Secondary to connect before installing"""

    # provision device with a secondary
    with secondary, aktualizr:
        aktualizr.wait_for_completion()

    secondary_image_filename = "secondary_image_filename.img"
    uptane_repo.add_image(id=secondary.id, image_filename=secondary_image_filename)

    with aktualizr:
        time.sleep(10)
        with secondary:
            aktualizr.wait_for_completion()

    if not director.get_install_result():
        logger.error("Installation result is not successful")
        return False

    return True


@with_uptane_backend()
@with_secondary(start=False, output_logs=False)
@with_aktualizr(start=False, output_logs=False)
def test_primary_timeout_after_device_is_registered(uptane_repo, secondary, aktualizr, **kwargs):
    '''Test Aktualizr's timeout of waiting for Secondaries after the device/aktualizr was registered at the backend'''

    # run aktualizr and Secondary and wait until the device/aktualizr is registered
    with aktualizr, secondary:
        aktualizr.wait_for_completion()

    # the Secondary must be registered
    if not aktualizr.is_ecu_registered(secondary.id):
        return False

    # make sure that the Secondary is not running
    if secondary.is_running():
        return False

    # run just aktualizr, the previously registered Secondary is off
    # and check if the Primary ECU is updatable if the Secondary is not connected
    primary_image_filename = "primary_image_filename_001.img"
    primary_image_hash = uptane_repo.add_image(id=aktualizr.id, image_filename=primary_image_filename)

    # if a new image for the not-connected Secondary is specified in the target
    # then nothing is going to be updated, including the image intended for
    # healthy Primary ECU
    # secondary_image_filename = "secondary_image_filename_001.img"
    # secondary_image_hash = uptane_repo.add_image(id=secondary.id, image_filename=secondary_image_filename)

    aktualizr.update_wait_timeout(0.1)
    with aktualizr:
        aktualizr.wait_for_completion()

    return aktualizr.get_current_primary_image_info() == primary_image_hash


@with_uptane_backend()
@with_secondary(start=False)
@with_secondary(start=False, arg_name='secondary2')
@with_aktualizr(start=False, output_logs=True)
def test_primary_multiple_secondaries(uptane_repo, secondary, secondary2, aktualizr, **kwargs):
    '''Test Aktualizr with multiple IP secondaries'''

    with aktualizr, secondary, secondary2:
        aktualizr.wait_for_completion()

    if not aktualizr.is_ecu_registered(secondary.id) or not aktualizr.is_ecu_registered(secondary2.id):
        return False

    return True
    secondary_image_filename = "secondary_image_filename.img"
    uptane_repo.add_image(id=secondary.id, image_filename=secondary_image_filename)
    uptane_repo.add_image(id=secondary2.id, image_filename=secondary_image_filename)

    with aktualizr:
        time.sleep(10)
        with secondary:
            aktualizr.wait_for_completion()

    if not director.get_install_result():
        logger.error("Installation result is not successful")
        return False

    return True


# test suit runner
if __name__ == '__main__':
    logging.basicConfig(level=logging.INFO)

    parser = argparse.ArgumentParser(description='Test IP Secondary')
    parser.add_argument('-b', '--build-dir', help='build directory', default='build')
    parser.add_argument('-s', '--src-dir', help='source directory', default='.')
    parser.add_argument('-o', '--ostree', help='OSTree support', action='store_true')

    input_params = parser.parse_args()

    KeyStore.base_dir = path.abspath(input_params.src_dir)
    initial_cwd = getcwd()
    chdir(input_params.build_dir)

    test_suite = [
                    test_secondary_update,
                    test_secondary_update_if_secondary_starts_first,
                    test_secondary_update_if_primary_starts_first,
                    test_add_secondary,
                    test_remove_secondary,
                    test_replace_secondary,
                    test_replace_secondary_same_port,
                    test_change_secondary_port,
                    test_secondary_install_timeout,
                    test_primary_timeout_during_first_run,
                    test_primary_timeout_after_device_is_registered,
                    test_primary_multiple_secondaries,
    ]

    if input_params.ostree:
        test_suite += [
           test_secondary_ostree_update,
           test_secondary_ostree_reboot,
        ]

    with TestRunner(test_suite) as runner:
        test_suite_run_result = runner.run()

    chdir(initial_cwd)
    exit(0 if test_suite_run_result else 1)