From b19344b16a3000180cac33e1239d62c7c6c3e5ea Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Sat, 18 Feb 2017 12:14:43 +0800 Subject: Refactoring qtip.base.error - move method make_tbd to qtip.util.dev - add suffix Error to follow the Python naming convention - rename arguments of NotFoundError to make it generic Change-Id: I81e406b7fa10c3b40004434f6a9c2e7bbf7603ee Signed-off-by: Yujun Zhang --- qtip/base/error.py | 16 ++++--------- qtip/loader/file.py | 4 ++-- qtip/loader/yaml_file.py | 4 ++-- qtip/runner/__init__.py | 12 +++++----- qtip/util/dev.py | 17 +++++++++++++ qtip/util/formula.py | 6 ++--- test-requirements.txt | 4 ++++ tests/unit/base/error_test.py | 48 +++++++++++++++++++++++++++++++++++++ tests/unit/loader/yaml_file_test.py | 4 ++-- tests/unit/util/dev_test.py | 32 +++++++++++++++++++++++++ 10 files changed, 121 insertions(+), 26 deletions(-) create mode 100644 qtip/util/dev.py create mode 100644 tests/unit/base/error_test.py create mode 100644 tests/unit/util/dev_test.py diff --git a/qtip/base/error.py b/qtip/base/error.py index a055aa8d..f23d8cd9 100644 --- a/qtip/base/error.py +++ b/qtip/base/error.py @@ -12,16 +12,16 @@ class BaseError(Exception): pass -class InvalidContent(BaseError): +class InvalidContentError(BaseError): def __init__(self, filename, excinfo=None): self.filename = filename self.excinfo = excinfo -class NotFound(BaseError): - def __init__(self, module, package='qtip'): - self.package = package - self.module = module +class NotFoundError(BaseError): + def __init__(self, needle, heystack='qtip'): + self.needle = needle + self.heystack = heystack class ToBeDoneError(BaseError): @@ -29,9 +29,3 @@ class ToBeDoneError(BaseError): def __init__(self, method, module): self.method = method self.module = module - - -def make_tbd(method, module='qtip'): - def tbd(): - raise ToBeDoneError(method, module) - return tbd diff --git a/qtip/loader/file.py b/qtip/loader/file.py index 0ea4d5b6..038f57dd 100644 --- a/qtip/loader/file.py +++ b/qtip/loader/file.py @@ -12,7 +12,7 @@ from os import listdir from os import path from qtip.base.constant import BaseProp -from qtip.base.error import NotFound +from qtip.base.error import NotFoundError from qtip.loader.base import BaseLoader @@ -35,7 +35,7 @@ class FileLoader(BaseLoader): abspath = path.join(p, self.RELATIVE_PATH, name) if path.exists(abspath): return abspath - raise NotFound(name, paths) + raise NotFoundError(name, paths) @classmethod def list_all(cls, paths=None): diff --git a/qtip/loader/yaml_file.py b/qtip/loader/yaml_file.py index 8b78a47c..7ff838f9 100644 --- a/qtip/loader/yaml_file.py +++ b/qtip/loader/yaml_file.py @@ -10,7 +10,7 @@ from os import path import yaml -from qtip.base.error import InvalidContent +from qtip.base.error import InvalidContentError from qtip.base.constant import BaseProp from qtip.loader.file import FileLoader @@ -25,6 +25,6 @@ class YamlFileLoader(FileLoader): with open(abspath, 'r') as stream: content = yaml.safe_load(stream) if not isinstance(content, dict): - raise InvalidContent(abspath) + raise InvalidContentError(abspath) self.content = content self.name = content.get(BaseProp.NAME, path.splitext(name)[0]) diff --git a/qtip/runner/__init__.py b/qtip/runner/__init__.py index 79c38850..52c43a14 100644 --- a/qtip/runner/__init__.py +++ b/qtip/runner/__init__.py @@ -8,7 +8,7 @@ ############################################################################## from qtip.base.constant import PkgName, BaseProp -from qtip.base.error import NotFound +from qtip.base.error import NotFoundError from qtip.collector.stdout import StdoutCollector from qtip.driver.random import RandomDriver from qtip.reporter.console import ConsoleReporter @@ -28,16 +28,16 @@ class Runner(object): if driver_name == 'random': self.driver = RandomDriver() else: - raise NotFound(driver_name, heystack=PkgName.DRIVER) + raise NotFoundError(driver_name, heystack=PkgName.DRIVER) if collector_name == 'stdout': self.collector = StdoutCollector() else: - raise NotFound(collector_name, - heystack=PkgName.COLLECTOR) + raise NotFoundError(collector_name, + heystack=PkgName.COLLECTOR) if reporter_name == 'console': self.reporter = ConsoleReporter() else: - raise NotFound(reporter_name, - heystack=PkgName.REPORTER) + raise NotFoundError(reporter_name, + heystack=PkgName.REPORTER) diff --git a/qtip/util/dev.py b/qtip/util/dev.py new file mode 100644 index 00000000..b77bf1eb --- /dev/null +++ b/qtip/util/dev.py @@ -0,0 +1,17 @@ +############################################################################## +# Copyright (c) 2017 ZTE Corporation and others. +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + + +from qtip.base.error import ToBeDoneError + + +def create_to_be_done(method, module='qtip'): + def tbd(): + raise ToBeDoneError(method, module) + return tbd diff --git a/qtip/util/formula.py b/qtip/util/formula.py index cdfbae86..e92d21f3 100644 --- a/qtip/util/formula.py +++ b/qtip/util/formula.py @@ -9,7 +9,7 @@ import numpy -from qtip.base.error import make_tbd +from qtip.util.dev import create_to_be_done from qtip.base.constant import FormulaName @@ -17,10 +17,10 @@ MAPPING = { FormulaName.ARITHMETIC_MEAN: numpy.mean, FormulaName.WEIGHTED_ARITHMETIC_MEAN: numpy.average, # TODO(yujunz) find or implement the method - FormulaName.GEOMETRIC_MEAN: make_tbd(FormulaName.GEOMETRIC_MEAN, __name__), + FormulaName.GEOMETRIC_MEAN: create_to_be_done(FormulaName.GEOMETRIC_MEAN, __name__), # TODO(yujunz) find or implement the method FormulaName.WEIGHTED_GEOMETRIC_MEAN: - make_tbd(FormulaName.GEOMETRIC_MEAN, __name__)} + create_to_be_done(FormulaName.GEOMETRIC_MEAN, __name__)} class Formula: diff --git a/test-requirements.txt b/test-requirements.txt index a5080127..e434748e 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,3 +9,7 @@ coverage pykwalify mock pip_check_reqs +coverage +pytest-cov +pytest-faker +tox diff --git a/tests/unit/base/error_test.py b/tests/unit/base/error_test.py new file mode 100644 index 00000000..2be6d695 --- /dev/null +++ b/tests/unit/base/error_test.py @@ -0,0 +1,48 @@ +############################################################### +# Copyright (c) 2017 ZTE Corporation +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +import pytest + +from qtip.base.error import InvalidContentError +from qtip.base.error import NotFoundError +from qtip.base.error import ToBeDoneError + + +def test_invalid_content(faker): + filename = faker.file_name() + error = InvalidContentError(filename) + assert error.filename == filename + + +def test_not_found(faker): + package = faker.pystr() + module = faker.pystr() + error = NotFoundError(module) + assert error.needle == module + assert error.heystack == 'qtip' + + error = NotFoundError(module, package) + assert error.needle == module + assert error.heystack == package + + +@pytest.fixture +def method(faker): + return faker.pystr() + + +@pytest.fixture +def module(faker): + return faker.pystr() + + +def test_to_be_done(method, module): + error = ToBeDoneError(method, module) + assert error.method == method + assert error.module == module diff --git a/tests/unit/loader/yaml_file_test.py b/tests/unit/loader/yaml_file_test.py index 17836946..0f0632c4 100644 --- a/tests/unit/loader/yaml_file_test.py +++ b/tests/unit/loader/yaml_file_test.py @@ -10,7 +10,7 @@ import os import pytest -from qtip.base.error import InvalidContent +from qtip.base.error import InvalidContentError from qtip.loader.yaml_file import YamlFileLoader @@ -28,6 +28,6 @@ def test_init(yaml_root, filename, expected): def test_invalid_content(yaml_root): - with pytest.raises(InvalidContent) as excinfo: + with pytest.raises(InvalidContentError) as excinfo: YamlFileLoader('invalid.yaml', [yaml_root]) assert 'invalid.yaml' in excinfo.value.filename diff --git a/tests/unit/util/dev_test.py b/tests/unit/util/dev_test.py new file mode 100644 index 00000000..021b1004 --- /dev/null +++ b/tests/unit/util/dev_test.py @@ -0,0 +1,32 @@ +############################################################### +# Copyright (c) 2017 ZTE Corporation +# +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Apache License, Version 2.0 +# which accompanies this distribution, and is available at +# http://www.apache.org/licenses/LICENSE-2.0 +############################################################################## + +import pytest + +from qtip.base.error import ToBeDoneError +from qtip.util.dev import create_to_be_done + + +def test_create_to_be_done(faker): + method = faker.pystr() + module = faker.pystr() + + tbd = create_to_be_done(method) + assert callable(tbd) + with pytest.raises(ToBeDoneError) as excinfo: + tbd() + assert excinfo.value.method == method + assert excinfo.value.module == 'qtip' + + tbd = create_to_be_done(method, module) + assert callable(tbd) + with pytest.raises(ToBeDoneError) as excinfo: + tbd() + assert excinfo.value.method == method + assert excinfo.value.module == module -- cgit 1.2.3-korg