Refactor the Code

Author: Abhilash Joseph C

.coveragerc

@@ -1,12 +1,12 @@
 # .coveragerc to control coverage.py
 [run]
 branch = True
-omit = py3resttest/runner.py
+omit = resttest3/runner.py
 
 command_line = --source py3resttest -m pytest tests/test_*.py
 [paths]
 source =
-    py3resttest/
+    resttest3/
 
 [report]
 # Regexes for lines to exclude from consideration

Dockerfile

@@ -14,16 +14,16 @@ COPY requirements.txt /tmp/requirements.txt
 
 #RUN pip install --no-cache-dir -r /tmp/requirements.txt
 
-COPY . /py3resttest
-WORKDIR /py3resttest
+COPY . /resttest3
+WORKDIR /resttest3
 
 
 RUN python setup.py bdist_wheel
 RUN pip install -U dist/*
-RUN flake8 py3resttest --count --select=E9,F63,F7,F82 --show-source --statistics
-RUN flake8 py3resttest --count --exit-zero --max-complexity=30 --max-line-length=127 --statistics
+RUN flake8 resttest3 --count --select=E9,F63,F7,F82 --show-source --statistics
+RUN flake8 resttest3 --count --exit-zero --max-complexity=30 --max-line-length=127 --statistics
 # RUN python -m pytest tests
-RUN coverage run --source py3resttest -m pytest tests/test_*.py
+RUN coverage run --source resttest3 -m pytest tests/test_*.py
 RUN coverage report
 #RUN resttest3 --url https://www.courtlistener.com --test tests/fun_test.yaml
 

coverage.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 # pip install coverage
-coverage run --source py3resttest -m pytest tests/test_*.py
+coverage run --source resttest3 -m pytest tests/test_*.py
 coverage html
 coverage report

docs/extensions.md

@@ -22,7 +22,7 @@ python pyresttest/resttest.py https://api.github.com fancypants_test.yaml --impo
 
 ## What does an extension look like?
 ```python
-import py3resttest.validators as validators
+import resttest3.validators as validators
 
 # Define a simple generator that doubles with each value
 def parse_generator_doubling(config):
@@ -44,11 +44,6 @@ GENERATORS = {'doubling': parse_generator_doubling}
 
 If this is imported when executing the test, you can now use this generator in tests. 
 
-# Full Example
-See the [sample extension](pyresttest/tests/sample_extension.py).  
-It shows an extension for all extensible functions. 
-
-
 # What Doe An Extension Need To Work?
 
 1. Function(s) to run 
@@ -105,6 +100,8 @@ The 'parse' function below will be registered in the registry.
 
 Example:
 ```python
+
+from resttest3.validators import AbstractExtractor
 class HeaderExtractor(AbstractExtractor):
     """ Extractor that pulls out a named header """
     extractor_type = 'header'  # Printable name for the type
@@ -133,6 +130,9 @@ Validators should extend AbstractValidator.
 The parse function below will be registered in the registry VALIDATORS. 
 
 ```python
+from resttest3.validators import AbstractValidator, _get_extractor, Failure
+from resttest3.utils import  Parser
+from resttest3.constants import  VALIDATOR_TESTS
 class ExtractTestValidator(AbstractValidator):
     """ Does extract and test from request body """
     name = 'ExtractTestValidator'
@@ -145,7 +145,7 @@ class ExtractTestValidator(AbstractValidator):
     def parse(config):
         """ Config is a dict """
         output = ExtractTestValidator()
-        config = parsing.lowercase_keys(parsing.flatten_dictionaries(config))
+        config = Parser.flatten_lowercase_keys_dict(config)
         output.config = config
         extractor = _get_extractor(config)
         output.extractor = extractor

py3resttest/__init__.py

@@ -0,0 +1,7 @@
+__version__ = '1.0.0-dev'
+__author__ = 'Abhilash Joseph C'
+
+from resttest3.utils import register_extensions
+
+register_extensions('resttest3.ext.validator_jsonschema')
+register_extensions('resttest3.ext.extractor_jmespath')

resttest3/__init__.py

@@ -5,11 +5,12 @@
 Basic context implementation for binding variables to values
 """
 
-logger = logging.getLogger('py3resttest')
+logger = logging.getLogger('resttest3')
 
 
-class Context(object):
+class Context:
     """ Manages binding of variables & generators, with both variable name and generator name being strings """
+
     # variables = {}
     def __init__(self):
         self.variables = {}  # Maps variable name to current value

py3resttest/binding.py renamed to resttest3/binding.py

@@ -1,7 +1,7 @@
 import os
 import string
 
-from py3resttest.utils import Parser
+from resttest3.utils import Parser
 
 """
 Encapsulates contend handling logic, for pulling file content into tests

py3resttest/constants.py renamed to resttest3/constants.py

@@ -2,7 +2,7 @@
 
 import jmespath
 
-from py3resttest.validators import AbstractExtractor
+from resttest3.validators import AbstractExtractor
 
 
 class JMESPathExtractor(AbstractExtractor):

py3resttest/contenthandling.py renamed to resttest3/contenthandling.py

@@ -4,10 +4,10 @@
 import jsonschema
 import yaml
 
-from py3resttest.constants import FAILURE_VALIDATOR_EXCEPTION
-from py3resttest.contenthandling import ContentHandler
-from py3resttest.utils import Parser
-from py3resttest.validators import AbstractValidator, Failure
+from resttest3.constants import FAILURE_VALIDATOR_EXCEPTION
+from resttest3.contenthandling import ContentHandler
+from resttest3.utils import Parser
+from resttest3.validators import AbstractValidator, Failure
 
 
 class JsonSchemaValidator(AbstractValidator):

py3resttest/exception.py renamed to resttest3/exception.py

@@ -10,7 +10,7 @@
 
 INT32_MAX_VALUE = 2147483647  # Max of 32 bit unsigned int
 
-logger = logging.getLogger('py3resttest.generators')
+logger = logging.getLogger('resttest3.generators')
 
 # Character sets to use in text generation, python string plus extras
 CHARACTER_SETS = {
@@ -213,7 +213,7 @@ def parse_generator(configuration):
     """ Parses a configuration built from yaml and returns a generator
         Configuration should be a map
     """
-    from py3resttest.utils import Parser
+    from resttest3.utils import Parser
     configuration = Parser.lowercase_keys(Parser.flatten_dictionaries(configuration))
     gen_type = str(configuration.get(u'type')).lower()
 

py3resttest/ext/__init__.py renamed to resttest3/ext/__init__.py

@@ -8,10 +8,10 @@
 import yaml
 from alive_progress import alive_bar
 
-from py3resttest.testcase import TestSet
-from py3resttest.utils import register_extensions
+from resttest3.testcase import TestSet
+from resttest3.utils import register_extensions
 
-logger = logging.getLogger('py3resttest')
+logger = logging.getLogger('resttest3')
 logging.basicConfig(format='%(levelname)s:%(message)s')
 
 

py3resttest/ext/extractor_jmespath.py renamed to resttest3/ext/extractor_jmespath.py

@@ -11,18 +11,18 @@
 
 import pycurl
 
-from py3resttest.binding import Context
-from py3resttest.constants import (
+from resttest3.binding import Context
+from resttest3.constants import (
     AuthType, YamlKeyWords, TestCaseKeywords, DEFAULT_TIMEOUT, EnumHttpMethod, FAILURE_CURL_EXCEPTION,
     FAILURE_TEST_EXCEPTION, FAILURE_INVALID_RESPONSE
 )
-from py3resttest.contenthandling import ContentHandler
-from py3resttest.exception import HttpMethodError, BindError, ValidatorError
-from py3resttest.generators import parse_generator
-from py3resttest.utils import read_testcase_file, ChangeDir, Parser
-from py3resttest.validators import parse_extractor, parse_validator, Failure
+from resttest3.contenthandling import ContentHandler
+from resttest3.exception import HttpMethodError, BindError, ValidatorError
+from resttest3.generators import parse_generator
+from resttest3.utils import read_testcase_file, ChangeDir, Parser
+from resttest3.validators import parse_extractor, parse_validator, Failure
 
-logger = logging.getLogger('py3resttest')
+logger = logging.getLogger('resttest3')
 
 
 class TestCaseConfig:

py3resttest/ext/validator_jsonschema.py renamed to resttest3/ext/validator_jsonschema.py

@@ -9,11 +9,11 @@
 
 import yaml
 
-from py3resttest.generators import register_generator
-from py3resttest.validators import register_test, register_comparator, register_extractor
-from py3resttest.validators import register_validator
+from resttest3.generators import register_generator
+from resttest3.validators import register_test, register_comparator, register_extractor
+from resttest3.validators import register_validator
 
-logger = logging.getLogger('py3resttest')
+logger = logging.getLogger('resttest3')
 
 
 class ChangeDir:

py3resttest/generators.py renamed to resttest3/generators.py

@@ -6,9 +6,9 @@
 from abc import abstractmethod, ABCMeta
 from typing import Dict, List, Union, Optional
 
-from py3resttest.constants import COMPARATORS, FAILURE_EXTRACTOR_EXCEPTION, FAILURE_VALIDATOR_FAILED, VALIDATOR_TESTS
+from resttest3.constants import COMPARATORS, FAILURE_EXTRACTOR_EXCEPTION, FAILURE_VALIDATOR_FAILED, VALIDATOR_TESTS
 
-logger = logging.getLogger('py3resttest.validators')
+logger = logging.getLogger('resttest3.validators')
 
 EXTRACTORS = {}
 VALIDATORS = {}
@@ -287,7 +287,7 @@ def parse(config):
                 expected: 'myValue'
               }
         """
-        from py3resttest.utils import Parser
+        from resttest3.utils import Parser
         output = ComparatorValidator()
         config = Parser.lowercase_keys(Parser.flatten_dictionaries(config))
         output.config = config
@@ -354,7 +354,7 @@ def get_readable_config(self, context=None):
 
     @staticmethod
     def parse(config):
-        from py3resttest.utils import Parser
+        from resttest3.utils import Parser
         output = ExtractTestValidator()
         config = Parser.lowercase_keys(Parser.flatten_dictionaries(config))
         output.config = config

py3resttest/runner.py renamed to resttest3/runner.py

@@ -11,7 +11,7 @@
                      '\n Documentation at https://abhijo89-to.github.io/py3resttest/',
     author="Abhilash Joseph C",
     author_email='[email protected]',
-    url='https://github.com/abhijo89-to/py3resttest',
+    url='https://github.com/abhijo89-to/resttest3',
     keywords=['rest', 'web', 'http', 'testing', 'api'],
     classifiers=[
         'Environment :: Console',
@@ -31,9 +31,9 @@
     license='Apache License, Version 2.0',
     install_requires=install_requires,
     tests_require=install_requires,
-    test_suite="py3resttest.tests",
+    test_suite="resttest3.tests",
     entry_points={
-        'console_scripts': ['resttest3=py3resttest.runner:main'],
+        'console_scripts': ['resttest3=resttest3.runner:main'],
     }
 
 )