zocker
/
python-simplezfs
mirror of https://github.com/Zocker1999NET/python-simplezfs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

enable E501 (line length) and format files accordingly

Browse Source
main
svalouch 6 years ago
parent 763f0e6178
commit 527504600a
9 changed files with 50 additions and 27 deletions
Show Stats Download Patch File Download Diff File

2
setup.cfg
Unescape Escape View File

@ -1,6 +1,6 @@
[flake8] [flake8]
ignore = E501,E402 ignore = E402
max-line-length = 119 max-line-length = 119
exclude = .git,.tox,build,_build,env,venv,__pycache__ exclude = .git,.tox,build,_build,env,venv,__pycache__

2
src/simplezfs/types.py
Unescape Escape View File

@ -107,7 +107,7 @@ class PropertySource(str, Enum):
INHERITED = 'inherited' INHERITED = 'inherited'
#: Property is temporary #: Property is temporary
TEMPORARY = 'temporary' TEMPORARY = 'temporary'
#: Property is set to the value that it had due to the sender of a "zfs send/receive" operation having it set this way. #: Property value is set due to a "zfs send/receive" operation.
RECEIVED = 'received' RECEIVED = 'received'
#: Property is set on the dataset in question #: Property is set on the dataset in question
NONE = 'none' NONE = 'none'

2
src/simplezfs/validation.py
Unescape Escape View File

@ -17,7 +17,7 @@ METADATA_PROPERTY_NAME_LEN_MAX: int = MAXNAMELEN
#: Maximum length of a metadata property value in bytes #: Maximum length of a metadata property value in bytes
METADATA_PROPERTY_VALUE_LEN_MAX: int = 8192 METADATA_PROPERTY_VALUE_LEN_MAX: int = 8192
#: Regular expression for validating dataset names, handling both the name itself as well as snapshot or bookmark names. #: Regular expression for validating dataset names, handling both the name itself as well as snapshot or bookmark names
DATASET_NAME_RE = re.compile(r'^(?P<dataset>[a-zA-Z0-9_\-.:]+)(?P<detail>(@|#)[a-zA-Z0-9_\-.:]+)?$') DATASET_NAME_RE = re.compile(r'^(?P<dataset>[a-zA-Z0-9_\-.:]+)(?P<detail>(@|#)[a-zA-Z0-9_\-.:]+)?$')
#: Regular expression for validating a native property name #: Regular expression for validating a native property name
NATIVE_PROPERTY_NAME_RE = re.compile(r'^[a-z]([a-z0-9]+)?$') NATIVE_PROPERTY_NAME_RE = re.compile(r'^[a-z]([a-z0-9]+)?$')

28
src/simplezfs/zfs.py
Unescape Escape View File

@ -45,8 +45,8 @@ class ZFS:
The functions :func:`set_property`, :func:`get_property` and :func:`get_properties` wrap the ZFS get/set The functions :func:`set_property`, :func:`get_property` and :func:`get_properties` wrap the ZFS get/set
functionality. To support so-called `user properties`, which are called `metadata` in this API, a default namespace functionality. To support so-called `user properties`, which are called `metadata` in this API, a default namespace
can be stored using `metadata_namespace` when instantiating the interface or by calling :func:`set_metadata_namespace` can be stored using `metadata_namespace` when instantiating the interface or by calling
at any time. :func:`set_metadata_namespace` at any time.
:note: Not setting a metadata namespace means that one can't set or get metadata properties, unless the overwrite :note: Not setting a metadata namespace means that one can't set or get metadata properties, unless the overwrite
parameter for the get/set functions is used. parameter for the get/set functions is used.
@ -155,8 +155,8 @@ class ZFS:
def list_datasets(self, *, parent: Union[str, Dataset] = None) -> List[Dataset]: def list_datasets(self, *, parent: Union[str, Dataset] = None) -> List[Dataset]:
''' '''
Lists all datasets known to the system. If ``parent`` is set to a pool or dataset name (or a :class:`~zfs.types.Dataset`), Lists all datasets known to the system. If ``parent`` is set to a pool or dataset name (or a
lists all the children of that dataset. :class:`~zfs.types.Dataset`), lists all the children of that dataset.
:param parent: If set, list all child datasets. :param parent: If set, list all child datasets.
:return: The list of datasets. :return: The list of datasets.
@ -177,7 +177,8 @@ class ZFS:
# real_use_pe_helper = use_pe_helper if use_pe_helper is not None else self.use_pe_helper # real_use_pe_helper = use_pe_helper if use_pe_helper is not None else self.use_pe_helper
raise NotImplementedError(f'not implemented yet') raise NotImplementedError(f'not implemented yet')
def set_property(self, dataset: str, key: str, value: str, *, metadata: bool = False, overwrite_metadata_namespace: Optional[str] = None) -> None: def set_property(self, dataset: str, key: str, value: str, *, metadata: bool = False,
overwrite_metadata_namespace: Optional[str] = None) -> None:
''' '''
Sets the ``value`` of the native property ``key``. By default, only native properties can be set. If Sets the ``value`` of the native property ``key``. By default, only native properties can be set. If
``metadata`` is set to **True**, the default metadata namespace is prepended or the one in ``metadata`` is set to **True**, the default metadata namespace is prepended or the one in
@ -237,12 +238,13 @@ class ZFS:
''' '''
raise NotImplementedError(f'{self} has not implemented this function') raise NotImplementedError(f'{self} has not implemented this function')
def get_property(self, dataset: str, key: str, *, metadata: bool = False, overwrite_metadata_namespace: Optional[str] = None) -> Property: def get_property(self, dataset: str, key: str, *, metadata: bool = False,
overwrite_metadata_namespace: Optional[str] = None) -> Property:
''' '''
Gets a specific property named ``key`` from the ``dataset``. By default, only native properties are returned. Gets a specific property named ``key`` from the ``dataset``. By default, only native properties are returned.
This behaviour can be changed by setting ``metadata`` to **True**, which uses the default `metadata_namespace` to This behaviour can be changed by setting ``metadata`` to **True**, which uses the default `metadata_namespace`
select the namespace. The namespace can be overwritten using ``overwrite_metadata_namespace`` for the duration of the to select the namespace. The namespace can be overwritten using ``overwrite_metadata_namespace`` for the
method invocaton. duration of the method invocaton.
:param dataset: Name of the dataset to get the property. Expects the full path beginning with the pool name. :param dataset: Name of the dataset to get the property. Expects the full path beginning with the pool name.
:param key: Name of the property to set. For non-native properties, set ``metadata`` to **True** and overwrite :param key: Name of the property to set. For non-native properties, set ``metadata`` to **True** and overwrite
@ -461,8 +463,8 @@ class ZFS:
.. warning:: .. warning::
On Linux, only root is allowed to manipulate the namespace (aka `mount`). Refer to :ref:`the_mount_problem` in On Linux, only root is allowed to manipulate the namespace (aka `mount`). Refer to :ref:`the_mount_problem`
the documentation. in the documentation.
:param name: The name of the new dataset. This includes the full path, e.g. ``tank/data/newdataset``. :param name: The name of the new dataset. This includes the full path, e.g. ``tank/data/newdataset``.
:param dataset_type: Indicates the type of the dataset to be created. :param dataset_type: Indicates the type of the dataset to be created.
@ -572,7 +574,9 @@ class ZFS:
# TODO # TODO
return self._create_dataset(name, dataset_type=dataset_type, properties=properties, metadata_properties=_metadata_properties, sparse=sparse, size=size, recursive=recursive) return self._create_dataset(name, dataset_type=dataset_type, properties=properties,
metadata_properties=_metadata_properties, sparse=sparse, size=size,
recursive=recursive)
def _create_dataset( def _create_dataset(
self, self,

3
src/simplezfs/zfs_cli.py
Unescape Escape View File

@ -204,7 +204,8 @@ class ZFSCli(ZFS):
if include_metadata: if include_metadata:
namespace = prop_name.split(':')[0] namespace = prop_name.split(':')[0]
prop_name = prop_name.lstrip(f'{namespace}:') prop_name = prop_name.lstrip(f'{namespace}:')
res.append(Property(key=prop_name, value=prop_value, source=property_source, namespace=namespace)) res.append(Property(key=prop_name, value=prop_value, source=property_source,
namespace=namespace))
else: else:
res.append(Property(key=prop_name, value=prop_value, source=property_source, namespace=None)) res.append(Property(key=prop_name, value=prop_value, source=property_source, namespace=None))
return res return res

6
src/simplezfs/zfs_native.py
Unescape Escape View File

@ -25,10 +25,12 @@ class ZFSNative(ZFS):
def __repr__(self) -> str: def __repr__(self) -> str:
return f'<ZFSNative(pe_helper="{self._pe_helper}", use_pe_helper="{self._use_pe_helper}")>' return f'<ZFSNative(pe_helper="{self._pe_helper}", use_pe_helper="{self._use_pe_helper}")>'
def set_property(self, dataset: str, key: str, value: str, *, metadata: bool = False, overwrite_metadata_namespace: Optional[str] = None) -> None: def set_property(self, dataset: str, key: str, value: str, *, metadata: bool = False,
overwrite_metadata_namespace: Optional[str] = None) -> None:
raise NotImplementedError raise NotImplementedError
def get_property(self, dataset: str, key: str, *, metadata: bool = False, overwrite_metadata_namespace: Optional[str] = None) -> Property: def get_property(self, dataset: str, key: str, *, metadata: bool = False,
overwrite_metadata_namespace: Optional[str] = None) -> Property:
raise NotImplementedError raise NotImplementedError
def get_properties(self, dataset: str, *, include_metadata: bool = False) -> List[Property]: def get_properties(self, dataset: str, *, include_metadata: bool = False) -> List[Property]:

12
tests/test_enums.py
Unescape Escape View File

@ -6,7 +6,10 @@ from simplezfs.types import DatasetType, PropertySource
class TestDatasetType: class TestDatasetType:
@pytest.mark.parametrize('string,value', [('FiLeSet', DatasetType.FILESET), ('fileset', DatasetType.FILESET), ('vOlUMe', DatasetType.VOLUME), ('volume', DatasetType.VOLUME), ('SnapSHOT', DatasetType.SNAPSHOT), ('snapshot', DatasetType.SNAPSHOT), ('BOOKmark', DatasetType.BOOKMARK), ('bookmark', DatasetType.BOOKMARK)]) @pytest.mark.parametrize('string,value', [('FiLeSet', DatasetType.FILESET), ('fileset', DatasetType.FILESET),
('vOlUMe', DatasetType.VOLUME), ('volume', DatasetType.VOLUME),
('SnapSHOT', DatasetType.SNAPSHOT), ('snapshot', DatasetType.SNAPSHOT),
('BOOKmark', DatasetType.BOOKMARK), ('bookmark', DatasetType.BOOKMARK)])
def test_from_string_valid(self, string, value): def test_from_string_valid(self, string, value):
''' '''
Tests that the from_string helper works. Tests that the from_string helper works.
@ -35,7 +38,12 @@ class TestDatasetType:
class TestPropertySource: class TestPropertySource:
@pytest.mark.parametrize('string,value', [('default', PropertySource.DEFAULT), ('DeFAULT', PropertySource.DEFAULT), ('inheriteD', PropertySource.INHERITED), ('inherited', PropertySource.INHERITED), ('TEMPORARY', PropertySource.TEMPORARY), ('temporary', PropertySource.TEMPORARY), ('rEcEiVeD', PropertySource.RECEIVED), ('received', PropertySource.RECEIVED), ('None', PropertySource.NONE), ('none', PropertySource.NONE)]) @pytest.mark.parametrize('string,value', [
('default', PropertySource.DEFAULT), ('DeFAULT', PropertySource.DEFAULT),
('inheriteD', PropertySource.INHERITED), ('inherited', PropertySource.INHERITED),
('TEMPORARY', PropertySource.TEMPORARY), ('temporary', PropertySource.TEMPORARY),
('rEcEiVeD', PropertySource.RECEIVED), ('received', PropertySource.RECEIVED),
('None', PropertySource.NONE), ('none', PropertySource.NONE)])
def test_from_string_valid(self, string, value): def test_from_string_valid(self, string, value):
''' '''
Test that the from_string helper works. Test that the from_string helper works.

14
tests/test_validation.py
Unescape Escape View File

@ -84,14 +84,18 @@ class TestDatasetName:
Tests the function ``validate_dataset_name``. Tests the function ``validate_dataset_name``.
''' '''
@pytest.mark.parametrize('name', ['a', 'aa', '0', '0a', 'A', 'A0', 'qwertzuiop', 'a-', '-a', 'a.a', '.', 'a:', ':a', 'a:a', 'a::a', '842bf5a29bd55c12c20a8d1e73bdb5790e8ab804d857885e35e55be025acb6b2', '842bf5a29bd55c12c20a8d1e73bdb5790e8ab804d857885e35e55be025acb6b2-init', 'towel@20190525', 'page#42']) @pytest.mark.parametrize('name', [
'a', 'aa', '0', '0a', 'A', 'A0', 'qwertzuiop', 'a-', '-a', 'a.a', '.', 'a:', ':a', 'a:a', 'a::a',
'842bf5a29bd55c12c20a8d1e73bdb5790e8ab804d857885e35e55be025acb6b2',
'842bf5a29bd55c12c20a8d1e73bdb5790e8ab804d857885e35e55be025acb6b2-init', 'towel@20190525', 'page#42'])
def test_valid_name(self, name): def test_valid_name(self, name):
''' '''
Tests a set of known good combinations. Tests a set of known good combinations.
''' '''
validate_dataset_name(name) validate_dataset_name(name)
@pytest.mark.parametrize('name', ['/a', '/', 'a/a', 'a/', 'a+', 'ä', '→', '\0', '\n', 'towel@@20190525', 'towel@#42', 'page##42', 'page#@20190525']) @pytest.mark.parametrize('name', ['/a', '/', 'a/a', 'a/', 'a+', 'ä', '→', '\0', '\n', 'towel@@20190525',
'towel@#42', 'page##42', 'page#@20190525'])
def test_invalid_name(self, name): def test_invalid_name(self, name):
''' '''
Tests a set of known invalid combinations. Tests a set of known invalid combinations.
@ -172,7 +176,8 @@ class TestNativePropertyName:
''' '''
validate_native_property_name(name) validate_native_property_name(name)
@pytest.mark.parametrize('name', ['0', '0a', 'A', 'AA', '-', 'a-', 'a-a', '-a', '_', 'a_', 'a_a', '_a', ':', 'a:', 'a:a', ':a', '\0']) @pytest.mark.parametrize('name', ['0', '0a', 'A', 'AA', '-', 'a-', 'a-a', '-a', '_', 'a_', 'a_a', '_a', ':', 'a:',
'a:a', ':a', '\0'])
def test_invalid_name(self, name): def test_invalid_name(self, name):
''' '''
Tests a set of known invalid combinations. Tests a set of known invalid combinations.
@ -211,7 +216,8 @@ class TestMetadataPropertyName:
''' '''
validate_metadata_property_name(name) validate_metadata_property_name(name)
@pytest.mark.parametrize('name', ['0', '0a', 'A', 'AA', '-', 'a-', 'a-a', '-a', '_', 'a_', 'a_a', '_a', ':', 'a:', '\0', 'a+:a']) @pytest.mark.parametrize('name', ['0', '0a', 'A', 'AA', '-', 'a-', 'a-a', '-a', '_', 'a_', 'a_a', '_a', ':', 'a:',
'\0', 'a+:a'])
def test_invalid_name(self, name): def test_invalid_name(self, name):
''' '''
Tests a set of known invalid combinations. Tests a set of known invalid combinations.

8
tests/test_zfs_cli.py
Unescape Escape View File

@ -97,7 +97,7 @@ class TestZFSCli:
subproc.assert_called_once() subproc.assert_called_once()
assert ['/bin/true', 'list', '-H', '-t', 'all', 'rpool'] == subproc.call_args[0][0] assert ['/bin/true', 'list', '-H', '-t', 'all', 'rpool'] == subproc.call_args[0][0]
assert data.pool == 'rpool' assert data.pool == 'rpool'
assert data.parent == None assert data.parent is None
assert data.name == 'rpool' assert data.name == 'rpool'
assert data.type == DatasetType.VOLUME assert data.type == DatasetType.VOLUME
assert data.full_path == 'rpool' assert data.full_path == 'rpool'
@ -158,7 +158,8 @@ tank/system/root 14.9G 13.3G 14.9G /'''
subproc.return_value = subprocess.CompletedProcess(args=[], returncode=0, stdout=test_stdout, stderr='') subproc.return_value = subprocess.CompletedProcess(args=[], returncode=0, stdout=test_stdout, stderr='')
zfs = ZFSCli(zfs_exe='/bin/true') zfs = ZFSCli(zfs_exe='/bin/true')
lst = zfs.list_datasets(parent=Dataset(pool='tank', name='system', full_path='tank', parent='tank', type=DatasetType.FILESET)) lst = zfs.list_datasets(parent=Dataset(pool='tank', name='system', full_path='tank', parent='tank',
type=DatasetType.FILESET))
subproc.assert_called_once() subproc.assert_called_once()
assert ['/bin/true', 'list', '-H', '-r', '-t', 'all', 'tank'] == subproc.call_args[0][0] assert ['/bin/true', 'list', '-H', '-r', '-t', 'all', 'tank'] == subproc.call_args[0][0]
assert len(lst) == 4 assert len(lst) == 4
@ -202,7 +203,8 @@ tank/system/root 14.9G 13.3G 14.9G /'''
subproc.return_value = subprocess.CompletedProcess(args=[], returncode=0, stdout=test_stdout, stderr='') subproc.return_value = subprocess.CompletedProcess(args=[], returncode=0, stdout=test_stdout, stderr='')
zfs = ZFSCli(zfs_exe='/bin/true') zfs = ZFSCli(zfs_exe='/bin/true')
lst = zfs.list_datasets(parent=Dataset(pool='tank', full_path='tank/system', name='system', parent='tank', type=DatasetType.FILESET)) lst = zfs.list_datasets(parent=Dataset(pool='tank', full_path='tank/system', name='system', parent='tank',
type=DatasetType.FILESET))
subproc.assert_called_once() subproc.assert_called_once()
assert ['/bin/true', 'list', '-H', '-r', '-t', 'all', 'tank/system'] == subproc.call_args[0][0] assert ['/bin/true', 'list', '-H', '-r', '-t', 'all', 'tank/system'] == subproc.call_args[0][0]
assert len(lst) == 3 assert len(lst) == 3

Write Preview
Loading…
Cancel
Save