feat: add docker-find script

Author: andreoliwa

clit/config.py

@@ -1,9 +1,10 @@
 """Configuration helpers."""
 import json
 import os
+from pathlib import Path
 from typing import List
 
-from clit.constants import CONFIG_DIR
+CONFIG_DIR = Path("~/.config/dotfiles/").expanduser()
 
 
 class JsonConfig:

clit/constants.py

@@ -3,10 +3,11 @@
 from pathlib import Path
 from typing import List, Optional
 
-from clit.constants import POSTGRES_DOCKER_CONTAINER_NAME
 from clit.docker import DockerContainer
 from clit.files import existing_directory_type, existing_file_type, shell
 
+POSTGRES_DOCKER_CONTAINER_NAME = "postgres10"
+
 
 class DatabaseServer:
     """A database server URI parser."""

clit/db.py

@@ -1,5 +1,6 @@
 """Development helpers."""
 import os
+import re
 from pathlib import Path
 from shutil import rmtree
 from subprocess import call, check_output
@@ -10,10 +11,17 @@
 from plumbum import FG, RETCODE
 from requests_html import HTMLSession
 
-from clit.constants import PYCHARM_MACOS_APP_PATH, TEST_NAMES_REGEX
 from clit.files import shell
 from clit.ui import prompt
 
+# Possible formats for tests:
+# ___ test_name ___
+# ___ Error on setup of test_name ___
+# ___ test_name[Parameter] ___
+TEST_NAMES_REGEX = re.compile(r"___ .*(test[^\[\] ]+)[\[\]A-Za-z]* ___")
+
+PYCHARM_MACOS_APP_PATH = Path("/Applications/PyCharm.app/Contents/MacOS/pycharm")
+
 
 @click.command()
 @click.argument("files", nargs=-1)
@@ -222,7 +230,7 @@ def setup_py():
         1,
         dedent(
             '''
-        """NOTICE: This file was generated automatically by the command: poetry-setup-py."""
+        """NOTICE: This file was generated automatically by the command: xpoetry setup-py."""
     '''
         ).strip(),
     )

clit/dev.py

@@ -1,11 +1,17 @@
 """Docker module."""
+import argparse
 import json
 from pathlib import Path
+from subprocess import PIPE
 from typing import List
 
-from clit.files import shell
+from clit.config import JsonConfig
+from clit.files import existing_directory_type, shell, shell_find
 from clit.types import JsonDict
 
+YML_DIRS = JsonConfig("docker-find-yml-dirs.json")
+YML_FILES = JsonConfig("docker-find-yml-files.json")
+
 
 class DockerContainer:
     """A helper for Docker containers."""
@@ -31,3 +37,103 @@ def replace_mount_dir(self, path: Path) -> Path:
                 new_path = str(path).replace(source, mount["Destination"])
                 return Path(new_path)
         return path
+
+
+def rescan_files(dirs):
+    """Rescan all directories and save the yml files that were found."""
+    sorted_dirs = sorted(dirs)
+    YML_DIRS.dump(sorted_dirs)
+
+    files = set()
+    for dir in sorted_dirs:
+        print(f"Files on {dir}")
+        for file in shell_find(f"{dir} -name docker-compose.yml"):
+            print(f"  {file}")
+            files.add(str(file))
+    sorted_files = sorted(files)
+    YML_FILES.dump(sorted_files)
+
+
+def scan_command(parser, args):
+    """Scan directories and add them to the list."""
+    dirs = YML_DIRS.load_set()
+    if not args.dir:
+        print(f"Rescanning existing directories")
+    for dir in args.dir:
+        dirs.add(str(dir))
+        print(f"Directory added: {dir}")
+    rescan_files(dirs)
+
+
+def rm_command(parser, args):
+    """Remove directories from the list."""
+    dirs = YML_DIRS.load_set()
+    for one_dir in args.dir:
+        str_dir = str(one_dir)
+        if str_dir in dirs:
+            dirs.remove(str_dir)
+            print(f"Directory removed: {one_dir}")
+        else:
+            print(f"Directory was not configured: {one_dir}")
+    rescan_files(dirs)
+
+
+def ls_command(parser, args):
+    """List registered yml files."""
+    for yml_file in sorted(YML_FILES.load_set()):
+        print(yml_file)
+
+
+def yml_command(parser, args):
+    """Run a docker-compose command on one of the yml files."""
+    found = set()
+    partial_name = args.yml_file
+
+    for file in YML_FILES.load_set():
+        if partial_name in file:
+            found.add(file)
+    if not found:
+        print(f"No .yml file was found with the string '{partial_name}'")
+        exit(1)
+
+    sorted_found = sorted(found)
+    if len(sorted_found) > 1:
+        choices = "\n".join(sorted_found)
+        chosen_yml = shell(f"echo '{choices}' | fzf --cycle --tac", quiet=True, stdout=PIPE).stdout.strip()
+        if not chosen_yml:
+            print("No .yml file was chosen")
+            exit(2)
+    else:
+        chosen_yml = sorted_found[0]
+    shell(f"docker-compose -f {chosen_yml} {' '.join(args.docker_compose_arg)}")
+
+
+# TODO: Convert to click
+def docker_find():
+    """Find docker.compose.yml files."""
+    parser = argparse.ArgumentParser(description="find docker.compose.yml files")
+    parser.set_defaults(chosen_function=None)
+    subparsers = parser.add_subparsers(title="commands")
+
+    parser_scan = subparsers.add_parser("scan", help="scan directories and add them to the list")
+    parser_scan.add_argument("dir", nargs="*", help="directory to scan", type=existing_directory_type)
+    parser_scan.set_defaults(chosen_function=scan_command)
+
+    parser_rm = subparsers.add_parser("rm", help="remove directories from the list")
+    parser_rm.add_argument("dir", nargs="+", help="directory to remove", type=existing_directory_type)
+    parser_rm.set_defaults(chosen_function=rm_command)
+
+    parser_ls = subparsers.add_parser("ls", help="list yml files")
+    parser_ls.set_defaults(chosen_function=ls_command)
+
+    parser_yml = subparsers.add_parser("yml", help="choose one of the yml files to call docker-compose on")
+    parser_yml.add_argument("yml_file", help="partial name of the desired .yml file")
+    parser_yml.add_argument("docker_compose_arg", nargs=argparse.REMAINDER, help="docker-compose arguments")
+    parser_yml.set_defaults(chosen_function=yml_command)
+
+    args = parser.parse_args()
+    if not args.chosen_function:
+        parser.print_help()
+        return
+    args.chosen_function(parser, args)
+    return

clit/docker.py

@@ -12,7 +12,9 @@
 from plumbum import FG
 
 from clit import CONFIG, LOGGER, read_config, save_config
-from clit.constants import SECTION_SYMLINKS_DIRS, SECTION_SYMLINKS_FILES
+
+SECTION_SYMLINKS_FILES = "symlinks/files"
+SECTION_SYMLINKS_DIRS = "symlinks/dirs"
 
 
 @click.command()

clit/files.py

@@ -24,13 +24,14 @@ classifiers = [
 # poetry run generate-setup-py
 [tool.poetry.scripts]
 backup-full = "clit.files:backup_full"
+docker-find = "clit.docker:docker_find"
 git-local-prune = "clit.git:prune_local_branches"
 git-vacuum = "clit.git:vacuum"
 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"
+xpytest = "clit.dev:extra_pytest"
 
 [tool.poetry.dependencies]
 python = "^3.6 || ^3.7"

pyproject.toml

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-"""NOTICE: This file was generated automatically by the command: poetry-setup-py."""
+"""NOTICE: This file was generated automatically by the command: xpoetry setup-py."""
 from distutils.core import setup
 
 packages = ["clit"]
@@ -20,6 +20,7 @@
 entry_points = {
     "console_scripts": [
         "backup-full = clit.files:backup_full",
+        "docker-find = clit.docker:docker_find",
         "git-local-prune = clit.git:prune_local_branches",
         "git-vacuum = clit.git:vacuum",
         "pycharm-cli = clit.dev:pycharm_cli",