Adds list and get subcommands for webapps.

Author: filiplajszczak

cli/webapp.py

@@ -6,13 +6,51 @@
 import typer
 from pythonanywhere_core.webapp import Webapp
 from snakesay import snakesay
+from tabulate import tabulate
 
 from pythonanywhere.project import Project
 from pythonanywhere.utils import ensure_domain
 
 app = typer.Typer(no_args_is_help=True)
 
 
+@app.command(name="list")
+def list_():
+    """List all your webapps"""
+    webapps = Webapp.list_webapps()
+    if not webapps:
+        typer.echo(snakesay("No webapps found."))
+        return
+
+    for webapp in webapps:
+        typer.echo(webapp['domain_name'])
+
+
+@app.command()
+def get(
+    domain_name: str = typer.Option(
+        "your-username.pythonanywhere.com",
+        "-d",
+        "--domain",
+        help="Domain name, eg www.mydomain.com",
+    )
+):
+    """Get details for a specific webapp"""
+    domain_name = ensure_domain(domain_name)
+    webapp = Webapp(domain_name)
+    webapp_info = webapp.get()
+
+    table = [
+        ["Domain", webapp_info['domain_name']],
+        ["Python version", webapp_info.get('python_version', 'unknown')],
+        ["Source directory", webapp_info.get('source_directory', 'not set')],
+        ["Virtualenv path", webapp_info.get('virtualenv_path', 'not set')],
+        ["Enabled", webapp_info.get('enabled', 'unknown')]
+    ]
+
+    typer.echo(tabulate(table, tablefmt="simple"))
+
+
 @app.command()
 def create(
     domain_name: str = typer.Option(
@@ -32,6 +70,7 @@ def create(
         help="*Irrevocably* delete any existing web app config on this domain. Irrevocably.",
     ),
 ):
+    """Create a new webapp with virtualenv and project setup"""
     domain = ensure_domain(domain_name)
     project = Project(domain, python_version)
     project.sanity_checks(nuke=nuke)
@@ -50,58 +89,21 @@ def create(
     )
 
 
-class LogType(str, Enum):
-    access = "access"
-    error = "error"
-    server = "server"
-    all = "all"
-
-
-def index_callback(value: str):
-    if value == "all" or (value.isnumeric() and int(value) in range(10)):
-        return value
-    raise typer.BadParameter(
-        "log_index has to be 0 for current log, 1-9 for one of archive logs or all for all of them"
-    )
-
-
 @app.command()
-def delete_logs(
+def reload(
     domain_name: str = typer.Option(
         "your-username.pythonanywhere.com",
         "-d",
         "--domain",
         help="Domain name, eg www.mydomain.com",
-    ),
-    log_type: LogType = typer.Option(
-        LogType.all,
-        "-t",
-        "--log-type",
-    ),
-    log_index: str = typer.Option(
-        "all",
-        "-i",
-        "--log-index",
-        callback=index_callback,
-        help="0 for current log, 1-9 for one of archive logs or all for all of them",
-    ),
+    )
 ):
-    webapp = Webapp(ensure_domain(domain_name))
-    log_types = ["access", "error", "server"]
-    logs = webapp.get_log_info()
-    if log_type == "all" and log_index == "all":
-        for key in log_types:
-            for log in logs[key]:
-                webapp.delete_log(key, log)
-    elif log_type == "all":
-        for key in log_types:
-            webapp.delete_log(key, int(log_index))
-    elif log_index == "all":
-        for i in logs[log_type]:
-            webapp.delete_log(log_type, int(i))
-    else:
-        webapp.delete_log(log_type, int(log_index))
-    typer.echo(snakesay("All done!"))
+    """Reload a webapp to apply code or configuration changes"""
+    domain_name = ensure_domain(domain_name)
+    webapp = Webapp(domain_name)
+    typer.echo(snakesay(f"Reloading {domain_name} via API"))
+    webapp.reload()
+    typer.echo(snakesay(f"{domain_name} has been reloaded"))
 
 
 @app.command()
@@ -134,6 +136,7 @@ def install_ssl(
         "-- this happens by default, use this option to suppress it.",
     ),
 ):
+    """Install SSL certificate and private key for a webapp"""
     with open(certificate_file, "r") as f:
         certificate = f.read()
 
@@ -157,17 +160,73 @@ def install_ssl(
     )
 
 
+class LogType(str, Enum):
+    access = "access"
+    error = "error"
+    server = "server"
+    all = "all"
+
+
+def index_callback(value: str):
+    if value == "all" or (value.isnumeric() and int(value) in range(10)):
+        return value
+    raise typer.BadParameter(
+        "log_index has to be 0 for current log, 1-9 for one of archive logs or all for all of them"
+    )
+
+
 @app.command()
-def reload(
+def delete_logs(
+    domain_name: str = typer.Option(
+        "your-username.pythonanywhere.com",
+        "-d",
+        "--domain",
+        help="Domain name, eg www.mydomain.com",
+    ),
+    log_type: LogType = typer.Option(
+        LogType.all,
+        "-t",
+        "--log-type",
+    ),
+    log_index: str = typer.Option(
+        "all",
+        "-i",
+        "--log-index",
+        callback=index_callback,
+        help="0 for current log, 1-9 for one of archive logs or all for all of them",
+    ),
+):
+    """Delete webapp log files (access, error, server logs)"""
+    webapp = Webapp(ensure_domain(domain_name))
+    log_types = ["access", "error", "server"]
+    logs = webapp.get_log_info()
+    if log_type == "all" and log_index == "all":
+        for key in log_types:
+            for log in logs[key]:
+                webapp.delete_log(key, log)
+    elif log_type == "all":
+        for key in log_types:
+            webapp.delete_log(key, int(log_index))
+    elif log_index == "all":
+        for i in logs[log_type]:
+            webapp.delete_log(log_type, int(i))
+    else:
+        webapp.delete_log(log_type, int(log_index))
+    typer.echo(snakesay("All done!"))
+
+
+@app.command()
+def delete(
     domain_name: str = typer.Option(
         "your-username.pythonanywhere.com",
         "-d",
         "--domain",
         help="Domain name, eg www.mydomain.com",
     )
 ):
+    """Delete a webapp"""
     domain_name = ensure_domain(domain_name)
     webapp = Webapp(domain_name)
-    typer.echo(snakesay(f"Reloading {domain_name} via API"))
-    webapp.reload()
-    typer.echo(snakesay(f"{domain_name} has been reloaded"))
+    typer.echo(snakesay(f"Deleting {domain_name} via API"))
+    webapp.delete()
+    typer.echo(snakesay(f"{domain_name} has been deleted"))

tests/test_cli_webapp.py

@@ -48,6 +48,43 @@ def test_main_subcommand_without_args_prints_help():
     assert "Show this message and exit." in result.stdout
 
 
+def test_list_webapps(mocker):
+    mock_webapp_class = mocker.patch("cli.webapp.Webapp")
+    mock_webapp_class.list_webapps.return_value = [
+        {"domain_name": "example1.com", "python_version": "python38"},
+        {"domain_name": "example2.pythonanywhere.com", "python_version": "python311"},
+    ]
+
+    result = runner.invoke(app, ["list"])
+
+    assert result.exit_code == 0
+    mock_webapp_class.list_webapps.assert_called_once()
+    assert "example1.com" in result.stdout
+    assert "example2.pythonanywhere.com" in result.stdout
+    assert "python38" not in result.stdout
+
+
+def test_get_webapp(mock_webapp, domain_name):
+    mock_webapp.return_value.get.return_value = {
+        "domain_name": domain_name,
+        "python_version": "python38",
+        "source_directory": "/home/user/mysite/",
+        "virtualenv_path": "/home/user/.virtualenvs/mysite/",
+        "enabled": True,
+    }
+
+    result = runner.invoke(app, ["get", "-d", domain_name])
+
+    assert result.exit_code == 0
+    mock_webapp.assert_called_once_with(domain_name)
+    mock_webapp.return_value.get.assert_called_once()
+    assert domain_name in result.stdout
+    assert "python38" in result.stdout
+    assert "/home/user/mysite/" in result.stdout
+    assert "Domain" in result.stdout
+    assert "Python version" in result.stdout
+
+
 def test_create_calls_all_stuff_in_right_order(mocker):
     mock_project = mocker.patch("cli.webapp.Project")
 
@@ -78,6 +115,59 @@ def test_create_calls_all_stuff_in_right_order(mocker):
     )
 
 
+def test_reload(mock_webapp, domain_name):
+    result = runner.invoke(app, ["reload", "-d", domain_name])
+
+    assert f"{domain_name} has been reloaded" in result.stdout
+    mock_webapp.assert_called_once_with(domain_name)
+    assert mock_webapp.return_value.method_calls == [call.reload()]
+
+
+def test_install_ssl_with_default_reload(mock_webapp, domain_name, file_with_content):
+    mock_webapp.return_value.get_ssl_info.return_value = {
+        "not_after": datetime(2018, 8, 24, 17, 16, 23, tzinfo=tzutc())
+    }
+    certificate = "certificate"
+    certificate_file = file_with_content(certificate)
+    private_key = "private_key"
+    private_key_file = file_with_content(private_key)
+
+    result = runner.invoke(
+        app,
+        ["install-ssl", domain_name, certificate_file, private_key_file],
+    )
+
+    mock_webapp.assert_called_once_with(domain_name)
+    mock_webapp.return_value.set_ssl.assert_called_once_with(certificate, private_key)
+    mock_webapp.return_value.reload.assert_called_once()
+    assert f"for {domain_name}" in result.stdout
+    assert "2018-08-24," in result.stdout
+
+
+def test_install_ssl_with_reload_suppressed(
+    mock_webapp, domain_name, file_with_content
+):
+    certificate = "certificate"
+    certificate_file = file_with_content(certificate)
+    private_key = "private_key"
+    private_key_file = file_with_content(private_key)
+
+    runner.invoke(
+        app,
+        [
+            "install-ssl",
+            domain_name,
+            certificate_file,
+            private_key_file,
+            "--suppress-reload",
+        ],
+    )
+
+    mock_webapp.assert_called_once_with(domain_name)
+    mock_webapp.return_value.set_ssl.assert_called_once_with(certificate, private_key)
+    mock_webapp.return_value.reload.assert_not_called()
+
+
 def test_delete_all_logs(mock_webapp, domain_name):
     result = runner.invoke(
         app,
@@ -154,54 +244,10 @@ def test_validates_log_number(mock_webapp):
     assert "log_index has to be 0 for current" in result.stdout
 
 
-def test_install_ssl_with_default_reload(mock_webapp, domain_name, file_with_content):
-    mock_webapp.return_value.get_ssl_info.return_value = {
-        "not_after": datetime(2018, 8, 24, 17, 16, 23, tzinfo=tzutc())
-    }
-    certificate = "certificate"
-    certificate_file = file_with_content(certificate)
-    private_key = "private_key"
-    private_key_file = file_with_content(private_key)
+def test_delete_webapp(mock_webapp, domain_name):
+    result = runner.invoke(app, ["delete", "-d", domain_name])
 
-    result = runner.invoke(
-        app,
-        ["install-ssl", domain_name, certificate_file, private_key_file],
-    )
-
-    mock_webapp.assert_called_once_with(domain_name)
-    mock_webapp.return_value.set_ssl.assert_called_once_with(certificate, private_key)
-    mock_webapp.return_value.reload.assert_called_once()
-    assert f"for {domain_name}" in result.stdout
-    assert "2018-08-24," in result.stdout
-
-
-def test_install_ssl_with_reload_suppressed(
-    mock_webapp, domain_name, file_with_content
-):
-    certificate = "certificate"
-    certificate_file = file_with_content(certificate)
-    private_key = "private_key"
-    private_key_file = file_with_content(private_key)
-
-    runner.invoke(
-        app,
-        [
-            "install-ssl",
-            domain_name,
-            certificate_file,
-            private_key_file,
-            "--suppress-reload",
-        ],
-    )
-
-    mock_webapp.assert_called_once_with(domain_name)
-    mock_webapp.return_value.set_ssl.assert_called_once_with(certificate, private_key)
-    mock_webapp.return_value.reload.assert_not_called()
-
-
-def test_reload(mock_webapp, domain_name):
-    result = runner.invoke(app, ["reload", "-d", domain_name])
-
-    assert f"{domain_name} has been reloaded" in result.stdout
+    assert result.exit_code == 0
     mock_webapp.assert_called_once_with(domain_name)
-    assert mock_webapp.return_value.method_calls == [call.reload()]
+    mock_webapp.return_value.delete.assert_called_once()
+    assert f"{domain_name} has been deleted" in result.stdout