feat: add xpostgres script

Author: andreoliwa

clit/constants.py

@@ -12,3 +12,4 @@
 # ___ Error on setup of test_name ___
 # ___ test_name[Parameter] ___
 TEST_NAMES_REGEX = re.compile(r"___ .*(test[^\[\] ]+)[\[\]A-Za-z]* ___")
+POSTGRES_DOCKER_CONTAINER_NAME = "postgres10"

clit/db.py

@@ -1,7 +1,11 @@
 """Database module."""
+import argparse
+from pathlib import Path
 from typing import List, Optional
 
-from clit.files import shell
+from clit.constants import POSTGRES_DOCKER_CONTAINER_NAME
+from clit.docker import DockerContainer
+from clit.files import existing_directory_type, existing_file_type, shell
 
 
 class DatabaseServer:
@@ -80,3 +84,63 @@ def list_databases(self) -> "PostgreSQLServer":
 
         self.databases = sorted(db.strip() for db in process.stdout.strip().split())
         return self
+
+
+def backup(parser, args):
+    """Backup PostgreSQL databases."""
+    pg = PostgreSQLServer(args.server_uri).list_databases()
+    container = DockerContainer(POSTGRES_DOCKER_CONTAINER_NAME)
+    for database in pg.databases:
+        sql_file: Path = Path(args.backup_dir) / f"{pg.protocol}_{pg.server}_{pg.port}" / f"{database}.sql"
+        sql_file.parent.mkdir(parents=True, exist_ok=True)
+
+        if pg.inside_docker:
+            sql_file = container.replace_mount_dir(sql_file)
+        shell(f"{pg.pg_dump} --clean --create --if-exists --file={sql_file} {pg.docker_uri}/{database}")
+
+
+def restore(parser, args):
+    """Restore PostgreSQL databases."""
+    pg = PostgreSQLServer(args.server_uri).list_databases()
+    new_database = args.database_name or args.sql_file.stem
+    if new_database in pg.databases:
+        print(f"The database {new_database!r} already exists in the server. Provide a new database name.")
+        exit(1)
+
+    if new_database != args.sql_file.stem:
+        # TODO Optional argument --owner to set the database owner
+        print(f"TODO: Create a user named {new_database!r} if it doesn't exist (or raise an error)")
+        print(f"TODO: Parse the .sql file and replace DATABASE/OWNER {args.sql_file.stem!r} by {new_database!r}")
+        exit(2)
+
+    shell(f"{pg.psql} {args.server_uri} < {args.sql_file}")
+
+
+# TODO: Convert to click
+def extra_postgres():
+    """Extra PostgreSQL tools like backup, restore, user creation, etc."""
+    parser = argparse.ArgumentParser(description="PostgreSQL helper tools")
+    parser.add_argument("server_uri", help="database server URI (postgresql://user:password@server:port)")
+    parser.set_defaults(chosen_function=None)
+    subparsers = parser.add_subparsers(title="commands")
+
+    parser_backup = subparsers.add_parser("backup", help="backup a PostgreSQL database to a SQL file")
+    parser_backup.add_argument("backup_dir", type=existing_directory_type, help="directory to store the backups")
+    parser_backup.set_defaults(chosen_function=backup)
+
+    parser_restore = subparsers.add_parser("restore", help="restore a PostgreSQL database from a SQL file")
+    parser_restore.add_argument(
+        "sql_file", type=existing_file_type, help="full path of the .sql file created by the 'backup' command"
+    )
+    parser_restore.add_argument("database_name", nargs="?", help="database name (default: basename of .sql file)")
+    parser_restore.set_defaults(chosen_function=restore)
+
+    # TODO Subcommand create-user new-user-name or alias user new-user-name to create a new user
+    # TODO xpostgres user myuser [mypass]
+
+    args = parser.parse_args()
+    if not args.chosen_function:
+        parser.print_help()
+        return
+    args.chosen_function(parser, args)
+    return

pyproject.toml

@@ -30,6 +30,7 @@ pycharm-cli = "clit.dev:pycharm_cli"
 xpytest = "clit.dev:extra_pytest"
 pypi = "clit.dev:pypi"
 xpoetry = "clit.dev:extra_poetry"
+xpostgres = "clit.db:extra_postgres"
 
 [tool.poetry.dependencies]
 python = "^3.6 || ^3.7"

setup.py

@@ -25,6 +25,7 @@
         "pycharm-cli = clit.dev:pycharm_cli",
         "pypi = clit.dev:pypi",
         "xpoetry = clit.dev:extra_poetry",
+        "xpostgres = clit.db:extra_postgres",
         "xpytest = clit.dev:extra_pytest",
     ]
 }