nginx-lens 0.3.4__tar.gz → 0.5.0__tar.gz

{nginx_lens-0.3.4/nginx_lens.egg-info → nginx_lens-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nginx-lens
-Version: 0.3.4
+Version: 0.5.0
 Summary: CLI-инструмент для анализа, визуализации и диагностики конфигураций Nginx
 Author: Daniil Astrouski
 Author-email: shelovesuastra@gmail.com
@@ -10,9 +10,14 @@ Requires-Dist: typer[all]>=0.9.0
 Requires-Dist: rich>=13.0.0
 Requires-Dist: requests>=2.25.0
 Requires-Dist: dnspython>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
 Dynamic: author
 Dynamic: author-email
 Dynamic: license-file
+Dynamic: provides-extra
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{nginx_lens-0.3.4 → nginx_lens-0.5.0}/commands/analyze.py

@@ -1,3 +1,4 @@
+import sys
 import typer
 from rich.console import Console
 from rich.table import Table
@@ -9,6 +10,7 @@ from analyzer.unused import find_unused_variables
 from parser.nginx_parser import parse_nginx_config
 from analyzer.rewrite import find_rewrite_issues
 from analyzer.dead_locations import find_dead_locations
+from exporter.json_yaml import format_analyze_results, print_export
 
 app = typer.Typer()
 console = Console()
@@ -41,7 +43,11 @@ ISSUE_META = {
 }
 SEVERITY_COLOR = {"high": "red", "medium": "orange3", "low": "yellow"}
 
-def analyze(config_path: str = typer.Argument(..., help="Путь к nginx.conf")):
+def analyze(
+    config_path: str = typer.Argument(..., help="Путь к nginx.conf"),
+    json: bool = typer.Option(False, "--json", help="Экспортировать результаты в JSON"),
+    yaml: bool = typer.Option(False, "--yaml", help="Экспортировать результаты в YAML"),
+):
     """
     Анализирует конфигурацию Nginx на типовые проблемы и best practices.
 
@@ -62,10 +68,10 @@ def analyze(config_path: str = typer.Argument(..., help="Путь к nginx.conf"
         tree = parse_nginx_config(config_path)
     except FileNotFoundError:
         console.print(f"[red]Файл {config_path} не найден. Проверьте путь к конфигу.[/red]")
-        return
+        sys.exit(1)
     except Exception as e:
         console.print(f"[red]Ошибка при разборе {config_path}: {e}[/red]")
-        return
+        sys.exit(1)
     conflicts = find_location_conflicts(tree)
     dups = find_duplicate_directives(tree)
     empties = find_empty_blocks(tree)

{nginx_lens-0.3.4 → nginx_lens-0.5.0}/commands/cli.py

@@ -10,6 +10,9 @@ from commands.graph import graph
 from commands.logs import logs
 from commands.syntax import syntax
 from commands.resolve import resolve
+from commands.validate import validate
+from commands.metrics import metrics
+from commands.completion import app as completion_app
 
 app = typer.Typer(help="nginx-lens — анализ и диагностика конфигураций Nginx")
 console = Console()
@@ -24,6 +27,9 @@ app.command()(graph)
 app.command()(logs)
 app.command()(syntax)
 app.command()(resolve)
+app.command()(validate)
+app.command()(metrics)
+app.add_typer(completion_app, name="completion", help="Генерация скриптов автодополнения")
 
 if __name__ == "__main__":
     app() 

nginx_lens-0.5.0/commands/completion.py

@@ -0,0 +1,174 @@
+"""
+Команда для генерации скриптов автодополнения.
+"""
+import sys
+import typer
+from rich.console import Console
+from rich.panel import Panel
+from rich import box
+
+app = typer.Typer()
+console = Console()
+
+
+def _generate_completion_script(shell: str) -> str:
+    """
+    Генерирует базовый completion скрипт для указанного shell.
+    
+    Args:
+        shell: Тип shell (bash, zsh, fish, powershell)
+        
+    Returns:
+        Строка с completion скриптом
+    """
+    commands = [
+        "health", "analyze", "tree", "diff", "route", "include",
+        "graph", "logs", "syntax", "resolve", "validate", "metrics"
+    ]
+    
+    if shell == "bash":
+        script = f"""# Bash completion for nginx-lens
+_nginx_lens_completion() {{
+    local cur="${{COMP_WORDS[COMP_CWORD]}}"
+    local commands="{' '.join(commands)}"
+    
+    if [[ ${{COMP_CWORD}} -eq 1 ]]; then
+        COMPREPLY=($(compgen -W "$commands" -- "$cur"))
+    else
+        COMPREPLY=($(compgen -f -- "$cur"))
+    fi
+}}
+
+complete -F _nginx_lens_completion nginx-lens
+"""
+    elif shell == "zsh":
+        script = f"""# Zsh completion for nginx-lens
+#compdef nginx-lens
+
+_nginx_lens() {{
+    local -a commands
+    commands=(
+        {' '.join(f'"{cmd}":{cmd}' for cmd in commands)}
+    )
+    
+    _describe 'command' commands
+}}
+
+_nginx_lens "$@"
+"""
+    elif shell == "fish":
+        script = f"""# Fish completion for nginx-lens
+complete -c nginx-lens -f -a "{' '.join(commands)}"
+"""
+    elif shell == "powershell":
+        script = f"""# PowerShell completion for nginx-lens
+Register-ArgumentCompleter -Native -CommandName nginx-lens -ScriptBlock {{
+    param($commandName, $wordToComplete, $cursorPosition)
+    
+    $commands = @({', '.join(f'"{cmd}"' for cmd in commands)})
+    
+    $commands | Where-Object {{ $_ -like "$wordToComplete*" }} | ForEach-Object {{
+        [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
+    }}
+}}
+"""
+    else:
+        script = f"# Completion script for {shell}\n# Use: typer commands.cli app {shell}\n"
+    
+    return script
+
+
+@app.command()
+def install(
+    shell: str = typer.Argument(..., help="Тип shell: bash, zsh, fish, powershell"),
+    output: str = typer.Option(None, "--output", "-o", help="Путь для сохранения скрипта (по умолчанию выводится в stdout)"),
+):
+    """
+    Генерирует скрипт автодополнения для указанного shell.
+    
+    После генерации нужно добавить его в конфигурацию shell:
+    
+    Bash:
+        nginx-lens completion install bash >> ~/.bashrc
+    
+    Zsh:
+        nginx-lens completion install zsh >> ~/.zshrc
+    
+    Fish:
+        nginx-lens completion install fish > ~/.config/fish/completions/nginx-lens.fish
+    
+    PowerShell:
+        nginx-lens completion install powershell > nginx-lens-completion.ps1
+        # Затем выполните: . .\nginx-lens-completion.ps1
+    """
+    import subprocess
+    import sys
+    
+    # Пробуем использовать typer CLI для генерации completion
+    completion_script = None
+    try:
+        result = subprocess.run(
+            [sys.executable, "-m", "typer", "commands.cli", "app", shell],
+            capture_output=True,
+            text=True,
+            check=False,
+            timeout=10
+        )
+        
+        if result.returncode == 0 and result.stdout and len(result.stdout.strip()) > 0:
+            completion_script = result.stdout
+    except (subprocess.TimeoutExpired, FileNotFoundError, Exception):
+        pass
+    
+    # Если typer CLI не сработал, используем базовый скрипт
+    if not completion_script:
+        completion_script = _generate_completion_script(shell)
+    
+    if shell not in ["bash", "zsh", "fish", "powershell"]:
+        console.print(f"[red]Неподдерживаемый shell: {shell}[/red]")
+        console.print("[yellow]Поддерживаемые shell: bash, zsh, fish, powershell[/yellow]")
+        raise typer.Exit(1)
+    
+    if output:
+        try:
+            with open(output, 'w') as f:
+                f.write(completion_script)
+            console.print(f"[green]✓ Скрипт автодополнения сохранен в {output}[/green]")
+            console.print(f"[yellow]Не забудьте добавить его в конфигурацию {shell}[/yellow]")
+        except Exception as e:
+            console.print(f"[red]Ошибка при сохранении файла: {e}[/red]")
+            raise typer.Exit(1)
+        else:
+            typer.echo(completion_script)
+            # Выводим инструкцию в stderr, чтобы не мешать скрипту
+            console.print("\n[yellow]Добавьте этот скрипт в конфигурацию вашего shell[/yellow]", file=sys.stderr)
+
+
+@app.command()
+def show_instructions():
+    """
+    Показывает инструкции по установке автодополнения для всех поддерживаемых shell.
+    """
+    console.print(Panel("[bold blue]Инструкции по установке автодополнения[/bold blue]", box=box.ROUNDED))
+    
+    console.print("\n[bold]Bash:[/bold]")
+    console.print("  nginx-lens completion install bash >> ~/.bashrc")
+    console.print("  source ~/.bashrc")
+    
+    console.print("\n[bold]Zsh:[/bold]")
+    console.print("  nginx-lens completion install zsh >> ~/.zshrc")
+    console.print("  source ~/.zshrc")
+    
+    console.print("\n[bold]Fish:[/bold]")
+    console.print("  mkdir -p ~/.config/fish/completions")
+    console.print("  nginx-lens completion install fish > ~/.config/fish/completions/nginx-lens.fish")
+    
+    console.print("\n[bold]PowerShell:[/bold]")
+    console.print("  nginx-lens completion install powershell > nginx-lens-completion.ps1")
+    console.print("  . .\\nginx-lens-completion.ps1")
+    console.print("  # Или добавьте в профиль PowerShell: $PROFILE")
+
+
+if __name__ == "__main__":
+    app()
+

{nginx_lens-0.3.4 → nginx_lens-0.5.0}/commands/diff.py

@@ -1,3 +1,4 @@
+import sys
 import typer
 from rich.console import Console
 from rich.table import Table
@@ -24,10 +25,10 @@ def diff(
             lines2 = f2.readlines()
     except FileNotFoundError as e:
         console.print(f"[red]Файл {e.filename} не найден. Проверьте путь к конфигу.[/red]")
-        return
+        sys.exit(1)
     except Exception as e:
         console.print(f"[red]Ошибка при чтении файлов: {e}[/red]")
-        return
+        sys.exit(1)
     maxlen = max(len(lines1), len(lines2))
     # Выравниваем длины
     lines1 += [''] * (maxlen - len(lines1))

{nginx_lens-0.3.4 → nginx_lens-0.5.0}/commands/graph.py

@@ -1,3 +1,4 @@
+import sys
 import typer
 from rich.console import Console
 from parser.nginx_parser import parse_nginx_config
@@ -21,10 +22,10 @@ def graph(
         tree = parse_nginx_config(config_path)
     except FileNotFoundError:
         console.print(f"[red]Файл {config_path} не найден. Проверьте путь к конфигу.[/red]")
-        return
+        sys.exit(1)
     except Exception as e:
         console.print(f"[red]Ошибка при разборе {config_path}: {e}[/red]")
-        return
+        sys.exit(1)
     routes = []
     # Для каждого server/location строим маршрут
     def walk(d, chain, upstreams):

nginx_lens-0.5.0/commands/health.py

@@ -0,0 +1,144 @@
+import sys
+from typing import Optional
+import typer
+from rich.console import Console
+from rich.table import Table
+from upstream_checker.checker import check_upstreams, resolve_upstreams
+from upstream_checker.dns_cache import disable_cache, enable_cache
+from parser.nginx_parser import parse_nginx_config
+from exporter.json_yaml import format_health_results, print_export
+from config.config_loader import get_config
+from utils.progress import ProgressManager
+
+app = typer.Typer()
+console = Console()
+
+def health(
+    config_path: str = typer.Argument(..., help="Путь к nginx.conf"),
+    timeout: Optional[float] = typer.Option(None, help="Таймаут проверки (сек)"),
+    retries: Optional[int] = typer.Option(None, help="Количество попыток"),
+    mode: Optional[str] = typer.Option(None, help="Режим проверки: tcp или http", case_sensitive=False),
+    resolve: bool = typer.Option(False, "--resolve", "-r", help="Показать резолвленные IP-адреса"),
+    max_workers: Optional[int] = typer.Option(None, "--max-workers", "-w", help="Максимальное количество потоков для параллельной обработки"),
+    json: bool = typer.Option(False, "--json", help="Экспортировать результаты в JSON"),
+    yaml: bool = typer.Option(False, "--yaml", help="Экспортировать результаты в YAML"),
+    no_cache: bool = typer.Option(False, "--no-cache", help="Отключить кэширование DNS резолвинга"),
+    cache_ttl: Optional[int] = typer.Option(None, "--cache-ttl", help="Время жизни кэша в секундах"),
+):
+    """
+    Проверяет доступность upstream-серверов, определённых в nginx.conf. Выводит таблицу.
+    Использует параллельную обработку для ускорения проверки множества upstream серверов.
+    Поддерживает кэширование результатов DNS резолвинга для ускорения повторных запусков.
+
+    Пример:
+        nginx-lens health /etc/nginx/nginx.conf
+        nginx-lens health /etc/nginx/nginx.conf --timeout 5 --retries 3 --mode http
+        nginx-lens health /etc/nginx/nginx.conf --resolve
+        nginx-lens health /etc/nginx/nginx.conf --max-workers 20
+        nginx-lens health /etc/nginx/nginx.conf --resolve --no-cache
+        nginx-lens health /etc/nginx/nginx.conf --resolve --cache-ttl 600
+    """
+    exit_code = 0
+    
+    # Загружаем конфигурацию
+    config = get_config()
+    defaults = config.get_defaults()
+    cache_config = config.get_cache_config()
+    
+    # Применяем значения из конфига, если не указаны через CLI
+    timeout = timeout if timeout is not None else defaults.get("timeout", 2.0)
+    retries = retries if retries is not None else defaults.get("retries", 1)
+    mode = mode if mode is not None else defaults.get("mode", "tcp")
+    max_workers = max_workers if max_workers is not None else defaults.get("max_workers", 10)
+    cache_ttl = cache_ttl if cache_ttl is not None else cache_config.get("ttl", defaults.get("dns_cache_ttl", 300))
+    
+    # Управление кэшем
+    use_cache = not no_cache and cache_config.get("enabled", True)
+    if no_cache:
+        disable_cache()
+    else:
+        enable_cache()
+    
+    try:
+        tree = parse_nginx_config(config_path)
+    except FileNotFoundError:
+        console.print(f"[red]Файл {config_path} не найден. Проверьте путь к конфигу.[/red]")
+        sys.exit(1)
+    except Exception as e:
+        console.print(f"[red]Ошибка при разборе {config_path}: {e}[/red]")
+        sys.exit(1)
+
+    upstreams = tree.get_upstreams()
+    
+    # Подсчитываем общее количество серверов для прогресс-бара
+    total_servers = sum(len(servers) for servers in upstreams.values())
+    
+    # Проверка upstream с прогресс-баром
+    with ProgressManager(description="Проверка upstream серверов", show_progress=total_servers > 5) as pm:
+        results = check_upstreams(upstreams, timeout=timeout, retries=retries, mode=mode.lower(), max_workers=max_workers, progress_manager=pm)
+    
+    # Если нужно показать резолвленные IP-адреса
+    resolved_info = {}
+    if resolve:
+        with ProgressManager(description="Резолвинг DNS", show_progress=total_servers > 5) as pm:
+            resolved_info = resolve_upstreams(upstreams, max_workers=max_workers, use_cache=use_cache, cache_ttl=cache_ttl, progress_manager=pm)
+
+    # Экспорт в JSON/YAML
+    if json or yaml:
+        export_data = format_health_results(results, resolved_info if resolve else None)
+        format_type = 'json' if json else 'yaml'
+        print_export(export_data, format_type)
+        # Exit code остается прежним
+        for name, servers in results.items():
+            for srv in servers:
+                if not srv["healthy"]:
+                    exit_code = 1
+                if resolve and name in resolved_info:
+                    for resolved_srv in resolved_info[name]:
+                        if resolved_srv["address"] == srv["address"]:
+                            if any("invalid resolve" in r for r in resolved_srv["resolved"]):
+                                exit_code = 1
+                            break
+        sys.exit(exit_code)
+
+    # Обычный вывод в таблицу
+    table = Table(show_header=True, header_style="bold blue")
+    table.add_column("Address")
+    table.add_column("Status")
+    if resolve:
+        table.add_column("Resolved IP")
+
+    for name, servers in results.items():
+        for srv in servers:
+            status = "Healthy" if srv["healthy"] else "Unhealthy"
+            color = "green" if srv["healthy"] else "red"
+            
+            # Проверяем статус здоровья
+            if not srv["healthy"]:
+                exit_code = 1
+            
+            if resolve:
+                resolved_list = []
+                if name in resolved_info:
+                    for resolved_srv in resolved_info[name]:
+                        if resolved_srv["address"] == srv["address"]:
+                            resolved_list = resolved_srv["resolved"]
+                            break
+                
+                if resolved_list:
+                    # Показываем все IP-адреса через запятую
+                    resolved_str = ", ".join(resolved_list)
+                    # Если есть "invalid resolve", показываем красным, иначе зеленым
+                    if any("invalid resolve" in r for r in resolved_list):
+                        table.add_row(srv["address"], f"[{color}]{status}[/{color}]", f"[red]{resolved_str}[/red]")
+                        exit_code = 1
+                    else:
+                        table.add_row(srv["address"], f"[{color}]{status}[/{color}]", f"[green]{resolved_str}[/green]")
+                else:
+                    table.add_row(srv["address"], f"[{color}]{status}[/{color}]", "[yellow]Failed to resolve[/yellow]")
+                    exit_code = 1
+            else:
+                table.add_row(srv["address"], f"[{color}]{status}[/{color}]")
+
+    console.print(table)
+    sys.exit(exit_code)

{nginx_lens-0.3.4 → nginx_lens-0.5.0}/commands/include.py

@@ -1,3 +1,4 @@
+import sys
 import typer
 from rich.console import Console
 from rich.tree import Tree
@@ -22,10 +23,10 @@ def include_tree(
         tree = build_include_tree(config_path)
     except FileNotFoundError:
         console.print(f"[red]Файл {config_path} не найден. Проверьте путь к конфигу.[/red]")
-        return
+        sys.exit(1)
     except Exception as e:
         console.print(f"[red]Ошибка при разборе {config_path}: {e}[/red]")
-        return
+        sys.exit(1)
     rich_tree = Tree(f"[bold blue]{config_path}[/bold blue]")
     def _add(node, t):
         for k, v in t.items():