Experiments with refactorings

.travis.yml

@@ -11,18 +11,15 @@ addons:
     - service2.example.com
     - service3.example.com
 install:
-  - travis_fold start "Install.Pip.Package" && make install-cloud && make install-dev && pip3 show mockintosh && travis_fold end "Install.Pip.Package"
-  - travis_fold start "Build.Image" && make build && docker image ls mockintosh && travis_fold end "Build.Image"
+  - travis_fold start "Install.Pip.Package" && pip install -e .[cloud] && pip install -e .[dev] && pip3 show mockintosh && travis_fold end "Install.Pip.Package"
+  - travis_fold start "Build.Image" && docker build . -t mockintosh && docker image ls mockintosh && travis_fold end "Build.Image"
 script:
   - stty cols 120
   - ./ps.sh &
-  - travis_fold start "Unit.Tests" && make test-with-coverage && travis_fold end "Unit.Tests"
-  - travis_fold start "StopContainers.Tests" && make stop-containers && travis_fold end "StopContainers.Tests"
-  - travis_fold start "Integration.Tests" && make test-integration && travis_fold end "Integration.Tests"
+  - travis_fold start "Unit.Tests" && coverage run -m pytest tests_unit && travis_fold end "Unit.Tests" && travis_fold start "Integration.Tests" && tests_integrated/acceptance.sh && travis_fold end "Integration.Tests"
 after_success:
+  - coverage report && codecov
   - if [[ $TRAVIS_TAG =~ ^([0-9]+\.?)+$ ]]; then git push --force https://${GH_TOKEN}@github.com/up9inc/mockintosh.git HEAD:gh-pages; else echo Not pushing "$TRAVIS_TAG"; fi
-  - make coverage-after
-  - codecov
 # after_failure:
 #  - travis_fold start "server_log" && ( cat tests_integrated/server.log || echo No logfile) && travis_fold end "server_log" # the log from container
 deploy:

docs/Changelog.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## v0.13 - next
+## v0.13 - 2021-09-17
 
 - create Homebrew repo for Mac users
 - add `--sample-config` to CLI, to obtain small sample config easily

mockintosh/__init__.py

@@ -1,55 +1,19 @@
-#!/usr/bin/python3
-# -*- coding: utf-8 -*-
-
-"""
-.. module:: __init__
-    :synopsis: the top-level module of Mockintosh.
-"""
-
-import argparse
-import atexit
 import json
 import logging
-import os
-import shutil
-import signal
-import sys
-from gettext import gettext
-from os import path, environ
-from typing import (
-    Union,
-    Tuple,
-    List
-)
-
-from prance import ValidationError
-from prance.util.url import ResolutionError
+from os import path
+from typing import Union
 
-from mockintosh.constants import PROGRAM
 from mockintosh.definition import Definition
-from mockintosh.helpers import _nostderr, _import_from
+from mockintosh.helpers import _nostderr
 from mockintosh.replicas import Request, Response  # noqa: F401
-from mockintosh.servers import HttpServer, TornadoImpl
-from mockintosh.templating import RenderingQueue, RenderingJob
-from mockintosh.transpilers import OASToConfigTranspiler
+from mockintosh.servers import TornadoImpl
 
 __location__ = path.abspath(path.dirname(__file__))
-with open(os.path.join(__location__, "res", "version.txt")) as fp:
+with open(path.join(__location__, "res", "version.txt")) as fp:
     __version__ = fp.read().strip()
 
-should_cov = environ.get('COVERAGE_PROCESS_START', False)
-cov_no_run = environ.get('COVERAGE_NO_RUN', False)
-
-
-class CustomArgumentParser(argparse.ArgumentParser):
-    def error(self, message):
-        self.print_help(sys.stderr)
-        args = {'prog': self.prog, 'message': message}
-        self.exit(2, gettext('\n%(prog)s: error: %(message)s\n') % args)
-
 
 def get_schema():
-    schema = None
     schema_path = path.join(__location__, 'schema.json')
     with open(schema_path, 'r') as file:
         schema_text = file.read()
@@ -58,27 +22,6 @@ def get_schema():
     return schema
 
 
-def import_interceptors(interceptors):
-    imported_interceptors = []
-    if interceptors is not None:
-        if 'unittest' in sys.modules.keys():
-            tests_dir = path.join(__location__, '../tests')
-            sys.path.append(tests_dir)
-        for interceptor in interceptors:
-            module, name = interceptor[0].rsplit('.', 1)
-            imported_interceptors.append(_import_from(module, name))
-    return imported_interceptors
-
-
-def start_render_queue() -> Tuple[RenderingQueue, RenderingJob]:
-    queue = RenderingQueue()
-    t = RenderingJob(queue)
-    t.daemon = True
-    t.start()
-
-    return queue, t
-
-
 def run(
         source: str,
         is_file: bool = True,
@@ -113,166 +56,22 @@ def run(
     http_server.run()
 
 
-def _gracefully_exit(num, frame):
-    atexit._run_exitfuncs()
-    if should_cov:  # pragma: no cover
-        sys.exit()
-
-
-def _cov_exit(cov):
-    if should_cov:
-        logging.debug('Stopping coverage')
-        cov.stop()
-        cov.save()  # pragma: no cover
-
-
-def _handle_cli_args_logging(args: list, fmt: str) -> None:
-    if args['quiet']:
-        logging.basicConfig(level=logging.WARNING, format=fmt)
-        logging.getLogger('pika').setLevel(logging.CRITICAL)
-        logging.getLogger('rsmq').setLevel(logging.CRITICAL)
-    elif args['verbose']:
-        logging.basicConfig(level=logging.DEBUG, format=fmt)
-    else:
-        logging.basicConfig(level=logging.INFO, format=fmt)
-        logging.getLogger('pika').setLevel(logging.CRITICAL)
-        logging.getLogger('rsmq').setLevel(logging.CRITICAL)
-    logging.getLogger('botocore').setLevel(logging.CRITICAL)
-    logging.getLogger('boto3').setLevel(logging.CRITICAL)
-    logging.getLogger('urllib3.connectionpool').setLevel(logging.CRITICAL)
-
-
-def _handle_cli_args_logfile(args: list, fmt: str) -> None:
-    if args['logfile']:
-        handler = logging.FileHandler(args['logfile'])
-        handler.setFormatter(logging.Formatter(fmt))
-        logging.getLogger('').addHandler(handler)
+class Mockintosh:
+    def __init__(self, bind_address='', interceptors=(), debug=False) -> None:
+        super().__init__()
+        self.management = Management()
 
+    def run(self):
+        pass
 
-def _handle_cli_args_tags(args: list) -> list:
-    tags = []
-    if args['enable_tags']:
-        tags = args['enable_tags'].split(',')
-    return tags
 
+class Service:
+    pass
 
-def _handle_cli_args(args: list) -> Tuple[tuple, str, list]:
-    interceptors = import_interceptors(args['interceptor'])
-    address = args['bind'] if args['bind'] is not None else ''
-    tags = _handle_cli_args_tags(args)
-    fmt = "[%(asctime)s %(name)s %(levelname)s] %(message)s"
-    _handle_cli_args_logging(args, fmt)
-    _handle_cli_args_logfile(args, fmt)
-
-    return interceptors, address, tags
-
-
-def _handle_oas_input(source: str, convert_args: List[str], direct: bool = False) -> Union[str, dict]:
-    oas_transpiler = OASToConfigTranspiler(source, convert_args)
-    return oas_transpiler.transpile(direct=direct)
-
-
-def initiate():
-    if should_cov:  # pragma: no cover
-        signal.signal(signal.SIGTERM, _gracefully_exit)
-        logging.debug('Starting coverage')
-        from coverage import Coverage
-        cov = Coverage(data_suffix=True, config_file='.coveragerc')
-        cov._warn_no_data = True
-        cov._warn_unimported_source = True
-        cov.start()
-        atexit.register(_cov_exit, cov)
-
-    """The top-level method to serve as the entry point of Mockintosh.
-
-    This method is the entry point defined in `setup.py` for the `mockintosh` executable that
-    placed a directory in `$PATH`.
-
-    This method parses the command-line arguments and handles the top-level initiations accordingly.
-    """
-
-    ap = CustomArgumentParser(formatter_class=argparse.RawTextHelpFormatter)
-    ap.add_argument(
-        'source',
-        help='Path to configuration file and (optional) a list of the service names\n'
-             'to specify the services to be listened.',
-        nargs='+'
-    )
-    ap.add_argument('-q', '--quiet', help='Less logging messages, only warnings and errors', action='store_true')
-    ap.add_argument('-v', '--verbose', help='More logging messages, including debug', action='store_true')
-    ap.add_argument(
-        '-i',
-        '--interceptor',
-        help='A list of interceptors to be called in <package>.<module>.<function> format',
-        action='append',
-        nargs='+'
-    )
-    ap.add_argument('-l', '--logfile', help='Also write log into a file', action='store')
-    ap.add_argument('-b', '--bind', help='Address to specify the network interface', action='store')
-    ap.add_argument(
-        '-c',
-        '--convert',
-        help='Convert an OpenAPI Specification (Swagger) 2.0 / 3.0 / 3.1 file to %s config. '
-             'Example: `$ mockintosh petstore.json -c dev.json json`' % PROGRAM.capitalize(),
-        action='store',
-        nargs='+',
-        metavar=('filename', 'format')
-    )
-    ap.add_argument('--enable-tags', help='A comma separated list of tags to enable', action='store')
-    ap.add_argument('--sample-config', help='Writes sample config file to disk', action='store_true')
-    args = vars(ap.parse_args())
-
-    interceptors, address, tags = _handle_cli_args(args)
-
-    if args['sample_config']:
-        fname = os.path.abspath(args['source'][0])
-        shutil.copy(os.path.join(__location__, "res", "sample.yml"), fname)
-        logging.info("Created sample configuration file in %r", fname)
-        logging.info("To run it, use the following command:\n    mockintosh %s", os.path.basename(fname))
-        sys.exit(0)
-
-    debug_mode = environ.get('DEBUG', False) or environ.get('MOCKINTOSH_DEBUG', False)
-    if debug_mode:
-        logging.debug('Tornado Web Server\'s debug mode is enabled!')
-
-    source = args['source'][0]
-    services_list = args['source'][1:]
-    convert_args = args['convert']
-
-    load_override = None
-
-    if convert_args:
-        if len(convert_args) < 2:
-            convert_args.append('yaml')
-        elif convert_args[1] != 'json':
-            convert_args[1] = 'yaml'
-
-        logging.info(
-            "Converting OpenAPI Specification %s to ./%s in %s format...",
-            source,
-            convert_args[0],
-            convert_args[1].upper()
-        )
-        target_path = _handle_oas_input(source, convert_args)
-        logging.info("The transpiled config %s is ready at %s", convert_args[1].upper(), target_path)
-    else:
-        try:
-            load_override = _handle_oas_input(source, ['config.yaml', 'yaml'], True)
-            logging.info("Automatically transpiled the config YAML from OpenAPI Specification.")
-        except (ValidationError, AttributeError):
-            logging.debug("The input is not a valid OpenAPI Specification, defaulting to Mockintosh config.")
-        except ResolutionError:  # pragma: no cover
-            pass
 
-        logging.info("%s v%s is starting...", PROGRAM.capitalize(), __version__)
+class Management(Service):
+    def set_config(self, config, services_list):
+        pass
 
-        if not cov_no_run:  # pragma: no cover
-            run(
-                source,
-                debug=debug_mode,
-                interceptors=interceptors,
-                address=address,
-                services_list=services_list,
-                tags=tags,
-                load_override=load_override
-            )
+    def set_enabled_tags(self, tags: list):
+        pass