feat: setup development environment with cli installer (#508)

Author: zhravan

api/Dockerfile.dev

@@ -0,0 +1,21 @@
+FROM golang:alpine
+ARG API_PORT=8443
+
+# Install air for live reload
+RUN apk add --no-cache bash git curl make && \
+    go install github.com/air-verse/air@latest
+
+WORKDIR /app
+
+# Pre-download dependencies
+COPY go.mod go.sum ./
+RUN go mod download
+COPY . .
+
+# Source code is mounted via volume
+ENV PORT=${API_PORT}
+EXPOSE ${API_PORT}
+
+# Use air with default config for live reload
+CMD ["air"]
+

api/doc/openapi.json

@@ -0,0 +1,78 @@
+import os
+import re
+
+from app.utils.config import Config
+from app.utils.protocols import LoggerProtocol
+
+from .messages import configuration_key_has_no_default_value
+
+
+class BaseInstall:
+    """Base class with shared logic for both production and development installations"""
+    
+    def __init__(
+        self,
+        logger: LoggerProtocol = None,
+        verbose: bool = False,
+        timeout: int = 300,
+        force: bool = False,
+        dry_run: bool = False,
+        config_file: str = None,
+        repo: str = None,
+        branch: str = None,
+    ):
+        self.logger = logger
+        self.verbose = verbose
+        self.timeout = timeout
+        self.force = force
+        self.dry_run = dry_run
+        self.config_file = config_file
+        self.repo = repo
+        self.branch = branch
+        self._user_config = Config().load_user_config(self.config_file)
+        self.progress = None
+        self.main_task = None
+    
+    def _get_config(self, key: str, user_config: dict = None, defaults: dict = None):
+        """Base config getter - override in subclasses for specific behavior"""
+        config = Config()
+        
+        # Override repo_url and branch_name if provided via command line
+        if key == "repo_url" and self.repo is not None:
+            return self.repo
+        if key == "branch_name" and self.branch is not None:
+            return self.branch
+        
+        try:
+            return config.get_config_value(key, user_config or self._user_config, defaults or {})
+        except ValueError:
+            raise ValueError(configuration_key_has_no_default_value.format(key=key))
+    
+    def _validate_domains(self, api_domain: str = None, view_domain: str = None):
+        """Validate domain format"""
+        if (api_domain is None) != (view_domain is None):
+            raise ValueError("Both api_domain and view_domain must be provided together, or neither should be provided")
+        
+        if api_domain and view_domain:
+            domain_pattern = re.compile(
+                r"^[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?))*$"
+            )
+            if not domain_pattern.match(api_domain) or not domain_pattern.match(view_domain):
+                raise ValueError("Invalid domain format. Domains must be valid hostnames")
+    
+    def _validate_repo(self):
+        """Validate repository URL format"""
+        if self.repo:
+            if not (
+                self.repo.startswith(("http://", "https://", "git://", "ssh://"))
+                or (self.repo.endswith(".git") and not self.repo.startswith("github.com:"))
+                or ("@" in self.repo and ":" in self.repo and self.repo.count("@") == 1)
+            ):
+                raise ValueError("Invalid repository URL format")
+    
+    def _is_custom_repo_or_branch(self, default_repo: str, default_branch: str):
+        """Check if custom repository or branch is provided"""
+        repo_differs = self.repo is not None and self.repo != default_repo
+        branch_differs = self.branch is not None and self.branch != default_branch
+        return repo_differs or branch_differs
+

cli/app/commands/install/base.py

@@ -6,6 +6,7 @@
 
 from .deps import install_all_deps
 from .run import Install
+from .development import DevelopmentInstall
 from .ssh import SSH, SSHConfig
 
 install_app = typer.Typer(help="Install Nixopus", invoke_without_command=True)
@@ -40,7 +41,7 @@ def install_callback(
         None, "--branch", "-b", help="Git branch to clone (defaults to config value)"
     ),
 ):
-    """Install Nixopus"""
+    """Install Nixopus for production"""
     if ctx.invoked_subcommand is None:
         logger = Logger(verbose=verbose)
         install = Install(
@@ -54,6 +55,7 @@ def install_callback(
             view_domain=view_domain,
             repo=repo,
             branch=branch,
+            development=False,
         )
         install.run()
 
@@ -66,6 +68,39 @@ def main_install_callback(value: bool):
         raise typer.Exit()
 
 
+@install_app.command(name="development")
+def development(
+    path: str = typer.Option(None, "--path", "-p", help="Installation directory (defaults to current directory)"),
+    verbose: bool = typer.Option(False, "--verbose", "-v", help="Show more details while installing"),
+    timeout: int = typer.Option(300, "--timeout", "-t", help="How long to wait for each step (in seconds)"),
+    force: bool = typer.Option(False, "--force", "-f", help="Replace files if they already exist"),
+    dry_run: bool = typer.Option(False, "--dry-run", "-d", help="See what would happen, but don't make changes"),
+    config_file: str = typer.Option(
+        None, "--config-file", "-c", help="Path to custom config file (defaults to config.dev.yaml)"
+    ),
+    repo: str = typer.Option(
+        None, "--repo", "-r", help="GitHub repository URL to clone (defaults to config value)"
+    ),
+    branch: str = typer.Option(
+        None, "--branch", "-b", help="Git branch to clone (defaults to config value)"
+    ),
+):
+    """Install Nixopus for local development in specified or current directory"""
+    logger = Logger(verbose=verbose)
+    install = DevelopmentInstall(
+        logger=logger,
+        verbose=verbose,
+        timeout=timeout,
+        force=force,
+        dry_run=dry_run,
+        config_file=config_file,
+        repo=repo,
+        branch=branch,
+        install_path=path,
+    )
+    install.run()
+
+
 @install_app.command(name="ssh")
 def ssh(
     path: str = typer.Option("~/.ssh/nixopus_rsa", "--path", "-p", help="The SSH key path to generate"),