Source code for avocado_i2n.states.btrfs

# Copyright 2013-2021 Intranet AG and contributors
#
# avocado-i2n is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# avocado-i2n is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with avocado-i2n.  If not, see <http://www.gnu.org/licenses/>.

"""
Module for the Btrfs state management backend.

SUMMARY
------------------------------------------------------

Copyright: Intra2net AG

INTERFACE
------------------------------------------------------

"""

from typing import Any

from virttest.utils_params import Params

from .setup import StateBackend




class BtrfsBackend(StateBackend):
    """Backend manipulating states as Btrfs volume snapshots."""



    @classmethod
    def show(cls, params: Params, object: Any = None) -> None:
        """
        Return a list of available states of a specific type.

        All arguments match the base class.
        """
        raise NotImplementedError("Implement Btrfs states based on demand.")




    @classmethod
    def get(cls, params: Params, object: Any = None) -> None:
        """
        Retrieve a state disregarding the current changes.

        All arguments match the base class.
        """
        raise NotImplementedError("Implement Btrfs states based on demand.")




    @classmethod
    def set(cls, params: Params, object: Any = None) -> None:
        """
        Store a state saving the current changes.

        All arguments match the base class.
        """
        raise NotImplementedError("Implement Btrfs states based on demand.")




    @classmethod
    def unset(cls, params: Params, object: Any = None) -> None:
        """
        Remove a state with previous changes.

        All arguments match the base class.
        """
        raise NotImplementedError("Implement Btrfs states based on demand.")




    @classmethod
    def check_root(cls, params: Params, object: Any = None) -> None:
        """
        Check whether a root state or essentially the object exists.

        All arguments match the base class.
        """
        raise NotImplementedError("Implement Btrfs states based on demand.")


    @classmethod
    def set_root(cls, params: Params, object: Any = None) -> None:
        """
        Set a root state to provide object existence.

        All arguments match the base class.
        """
        raise NotImplementedError("Implement Btrfs states based on demand.")



    @classmethod
    def unset_root(cls, params: Params, object: Any = None) -> None:
        """
        Unset a root state to prevent object existence.

        All arguments match the base class and in addition:
        """
        raise NotImplementedError("Implement Btrfs states based on demand.")