Add Simple Server and Coverage action (#2168)

* Add Simple Server and CodeCov action

* Remove token

* Codecov to tox.ini

* fix tox

* Set coverage location

* Add ignore to codecov

* Try glob ignore

* Setup CodeClimate

* Allow coverage check to run

* Change coverage check

* Add codeclimate exclusions

sanic/__main__.py

@@ -3,6 +3,7 @@ import sys
 
 from argparse import ArgumentParser, RawTextHelpFormatter
 from importlib import import_module
+from pathlib import Path
 from typing import Any, Dict, Optional
 
 from sanic_routing import __version__ as __routing_version__  # type: ignore
@@ -11,6 +12,7 @@ from sanic import __version__
 from sanic.app import Sanic
 from sanic.config import BASE_LOGO
 from sanic.log import error_logger
+from sanic.simple import create_simple_server
 
 
 class SanicArgumentParser(ArgumentParser):
@@ -37,13 +39,28 @@ def main():
         action="version",
         version=f"Sanic {__version__}; Routing {__routing_version__}",
     )
+    parser.add_argument(
+        "--factory",
+        action="store_true",
+        help=(
+            "Treat app as an application factory, "
+            "i.e. a () -> <Sanic app> callable"
+        ),
+    )
+    parser.add_argument(
+        "-s",
+        "--simple",
+        dest="simple",
+        action="store_true",
+        help="Run Sanic as a Simple Server (module arg should be a path)\n ",
+    )
     parser.add_argument(
         "-H",
         "--host",
         dest="host",
         type=str,
         default="127.0.0.1",
-        help="host address [default 127.0.0.1]",
+        help="Host address [default 127.0.0.1]",
     )
     parser.add_argument(
         "-p",
@@ -51,7 +68,7 @@ def main():
         dest="port",
         type=int,
         default=8000,
-        help="port to serve on [default 8000]",
+        help="Port to serve on [default 8000]",
     )
     parser.add_argument(
         "-u",
@@ -62,7 +79,7 @@ def main():
         help="location of unix socket\n ",
     )
     parser.add_argument(
-        "--cert", dest="cert", type=str, help="location of certificate for SSL"
+        "--cert", dest="cert", type=str, help="Location of certificate for SSL"
     )
     parser.add_argument(
         "--key", dest="key", type=str, help="location of keyfile for SSL\n "
@@ -70,14 +87,6 @@ def main():
     parser.add_bool_arguments(
         "--access-logs", dest="access_log", help="display access logs"
     )
-    parser.add_argument(
-        "--factory",
-        action="store_true",
-        help=(
-            "Treat app as an application factory, "
-            "i.e. a () -> <Sanic app> callable\n "
-        ),
-    )
     parser.add_argument(
         "-w",
         "--workers",
@@ -103,7 +112,12 @@ def main():
         help="Extra directories to watch and reload on changes\n ",
     )
     parser.add_argument(
-        "module", help="path to your Sanic app. Example: path.to.server:app"
+        "module",
+        help=(
+            "Path to your Sanic app. Example: path.to.server:app\n"
+            "If running a Simple Server, path to directory to serve. "
+            "Example: ./\n"
+        ),
     )
     args = parser.parse_args()
 
@@ -112,25 +126,29 @@ def main():
         if module_path not in sys.path:
             sys.path.append(module_path)
 
-        delimiter = ":" if ":" in args.module else "."
-        module_name, app_name = args.module.rsplit(delimiter, 1)
+        if args.simple:
+            path = Path(args.module)
+            app = create_simple_server(path)
+        else:
+            delimiter = ":" if ":" in args.module else "."
+            module_name, app_name = args.module.rsplit(delimiter, 1)
 
-        if app_name.endswith("()"):
-            args.factory = True
-            app_name = app_name[:-2]
+            if app_name.endswith("()"):
+                args.factory = True
+                app_name = app_name[:-2]
 
-        module = import_module(module_name)
-        app = getattr(module, app_name, None)
-        if args.factory:
-            app = app()
+            module = import_module(module_name)
+            app = getattr(module, app_name, None)
+            if args.factory:
+                app = app()
 
-        app_type_name = type(app).__name__
+            app_type_name = type(app).__name__
 
-        if not isinstance(app, Sanic):
-            raise ValueError(
-                f"Module is not a Sanic app, it is a {app_type_name}.  "
-                f"Perhaps you meant {args.module}.app?"
-            )
+            if not isinstance(app, Sanic):
+                raise ValueError(
+                    f"Module is not a Sanic app, it is a {app_type_name}.  "
+                    f"Perhaps you meant {args.module}.app?"
+                )
         if args.cert is not None or args.key is not None:
             ssl: Optional[Dict[str, Any]] = {
                 "cert": args.cert,

sanic/simple.py

@@ -0,0 +1,21 @@
+from pathlib import Path
+
+from sanic import Sanic
+from sanic.exceptions import SanicException
+from sanic.response import redirect
+
+
+def create_simple_server(directory: Path):
+    if not directory.is_dir():
+        raise SanicException(
+            "Cannot setup Sanic Simple Server without a path to a directory"
+        )
+
+    app = Sanic("SimpleServer")
+    app.static("/", directory, name="main")
+
+    @app.get("/")
+    def index(_):
+        return redirect(app.url_for("main", filename="index.html"))
+
+    return app