[DOCS] Adding documentation and base structure of the repo

Author: Cataldir

.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+name: ci
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  test-and-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Install tooling
+        run: |
+          python -m pip install --upgrade pip
+          pip install pylint isort black pytest pytest-cov pytest-asyncio
+      - name: Install lib
+        run: pip install -e lib
+      - name: Install apps
+        run: |
+          for d in apps/*; do
+            pip install -e "$d/src"
+          done
+      - name: Lint
+        run: |
+          python -m isort --check-only lib apps
+          python -m black --check lib apps
+          python -m pylint lib/src apps/*/src
+      - name: Tests with coverage
+        env:
+          PYTHONPATH: "${{ github.workspace }}/lib/src"
+        run: |
+          pytest lib/tests apps/**/tests --maxfail=1 --cov=. --cov-report=term-missing --cov-fail-under=75
+
+  build-and-push:
+    needs: test-and-lint
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    env:
+      REGISTRY: ghcr.io/${{ github.repository_owner }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push images
+        run: |
+          for d in apps/*; do
+            image_name=$(basename "$d")
+            docker build -t "$REGISTRY/$image_name:latest" -f "$d/src/Dockerfile" "$d"
+            docker push "$REGISTRY/$image_name:latest"
+          done

.infra/README.md

@@ -0,0 +1,28 @@
+# Infra CLI quickstart
+
+The CLI in this folder generates Dockerfiles and per-app Bicep modules from templates.
+
+## Prerequisites
+- Python 3.13+
+- Azure CLI (`az`) if you plan to deploy
+- Configure the CLI env once: from the repo root `bash .infra/config-cli.sh` (creates .infra/.venv and installs deps)
+
+To reuse the env later: `source .infra/.venv/bin/activate`.
+
+## Generate Bicep modules
+- One app: `python .infra/cli.py generate-bicep --service <app>`
+- All apps: `python .infra/cli.py generate-bicep --apply-all`
+- Output: `.infra/modules/<app>/<app>.bicep` and `.infra/modules/<app>/<app>-main.bicep` rendered from templates in `.infra/templates/`
+
+## Generate Dockerfiles
+- One app: `python .infra/cli.py generate-dockerfile --service <app>`
+- All apps: `python .infra/cli.py generate-dockerfile --apply-all`
+- Output: `<repo>/apps/<app>/src/Dockerfile` rendered from `.infra/templates/Dockerfile.template`
+
+## Deploy (optional)
+- One app: `python .infra/cli.py deploy --service <app> --location <region> [--subscription-id <id>] [--resource-group <name>] [--app-image <image>]`
+- All apps: `python .infra/cli.py deploy-all --location <region> [--subscription-id <id>] [--resource-group-prefix <prefix>] [--app-image <image>]`
+
+Notes:
+- The default image is `ghcr.io/OWNER/<app>:latest`; override with `--app-image`.
+- Templates live in `.infra/templates/`; adjust them before regenerating output files.

.infra/cli.py

@@ -0,0 +1,151 @@
+"""Typer CLI to deploy services via Bicep and maintain Dockerfiles."""
+import subprocess
+from pathlib import Path
+from typing import Optional
+
+import typer
+
+app = typer.Typer(help="Provision Holiday Peak Hub services")
+
+ROOT = Path(__file__).parent
+APPS_DIR = ROOT.parent / "apps"
+TEMPLATE_DIR = ROOT / "templates"
+
+def load_template(template_name: str) -> str:
+    path = TEMPLATE_DIR / template_name
+    if not path.exists():
+        raise typer.BadParameter(f"Template not found: {path}")
+    return path.read_text(encoding="utf-8")
+
+
+def deploy_file(
+    file_path: Path,
+    app_name: str,
+    resource_group: str,
+    location: str,
+    app_image: str,
+    subscription_id: Optional[str],
+) -> None:
+    typer.echo(
+        f"Deploying {file_path.name} to {resource_group} in {location}"
+    )
+    cmd = [
+        "az",
+        "deployment",
+        "sub",
+        "create",
+        "--location",
+        location,
+        "--template-file",
+        str(file_path),
+        "--parameters",
+        f"location={location}",
+        f"resourceGroupName={resource_group}",
+        f"appName={app_name}",
+        f"appImage={app_image}",
+    ]
+    if subscription_id:
+        cmd.extend(["--subscription", subscription_id, "--parameters", f"subscriptionId={subscription_id}"])
+    subprocess.run(cmd, check=False)
+
+
+def default_resource_group(service: str) -> str:
+    return f"{service}-rg"
+
+
+def write_bicep_files(app_name: str) -> tuple[Path, Path]:
+    module_dir = ROOT / "modules" / app_name
+    module_dir.mkdir(parents=True, exist_ok=True)
+    app_bicep = module_dir / f"{app_name}.bicep"
+    main_bicep = module_dir / f"{app_name}-main.bicep"
+    app_template = load_template("app.bicep.tpl")
+    main_template = load_template("main.bicep.tpl")
+    app_bicep.write_text(app_template.replace("{app_name}", app_name), encoding="utf-8")
+    main_bicep.write_text(main_template.replace("{app_name}", app_name), encoding="utf-8")
+    typer.echo(f"Wrote {app_bicep} and {main_bicep}")
+    return app_bicep, main_bicep
+
+
+@app.command()
+def deploy(
+    service: str,
+    resource_group: Optional[str] = typer.Option(None, help="Name of the resource group to create/use"),
+    location: str = typer.Option("eastus", help="Azure region"),
+    app_image: Optional[str] = typer.Option(None, help="Container image to deploy to AKS"),
+    subscription_id: Optional[str] = typer.Option(None, help="Azure subscription ID"),
+) -> None:
+    main_bicep = ROOT / "modules" / service / f"{service}-main.bicep"
+    if not main_bicep.exists():
+        typer.echo(f"No Bicep found for {service}; generating from template.")
+        write_bicep_files(service)
+    rg = resource_group or default_resource_group(service)
+    image = app_image or f"ghcr.io/OWNER/{service}:latest"
+    deploy_file(main_bicep, service, rg, location, image, subscription_id)
+
+
+@app.command()
+def deploy_all(
+    resource_group_prefix: Optional[str] = typer.Option(None, help="Prefix for RG names; defaults to <service>-rg"),
+    location: str = typer.Option("eastus", help="Azure region"),
+    app_image: Optional[str] = typer.Option(None, help="Container image to deploy to AKS"),
+    subscription_id: Optional[str] = typer.Option(None, help="Azure subscription ID"),
+) -> None:
+    for app_path in APPS_DIR.iterdir():
+        if not app_path.is_dir():
+            continue
+        service = app_path.name
+        main_bicep = ROOT / "modules" / service / f"{service}-main.bicep"
+        if not main_bicep.exists():
+            write_bicep_files(service)
+        rg = resource_group_prefix or default_resource_group(service)
+        image = app_image or f"ghcr.io/OWNER/{service}:latest"
+        deploy_file(main_bicep, service, rg, location, image, subscription_id)
+
+
+@app.command()
+def generate_bicep(
+    service: Optional[str] = typer.Option(None, help="Service name under apps/ (omit to apply --all)"),
+    apply_all: bool = typer.Option(False, help="Regenerate Bicep for all services"),
+) -> None:
+    if apply_all:
+        for app_path in APPS_DIR.iterdir():
+            if app_path.is_dir():
+                write_bicep_files(app_path.name)
+        return
+    if not service:
+        raise typer.BadParameter("Provide --service or --apply-all")
+    app_path = APPS_DIR / service
+    if not app_path.exists():
+        raise typer.BadParameter(f"Unknown service path: {app_path}")
+    write_bicep_files(service)
+
+
+def write_dockerfile(app_path: Path) -> None:
+    app_name = app_path.name
+    docker_path = app_path / "src" / "Dockerfile"
+    template = load_template("Dockerfile.template")
+    content = template.format(app_name=app_name)
+    docker_path.write_text(content, encoding="utf-8")
+    typer.echo(f"Wrote Dockerfile for {app_name} to {docker_path}")
+
+
+@app.command()
+def generate_dockerfile(
+    service: Optional[str] = typer.Option(None, help="Service name under apps/ (omit to apply --all)"),
+    apply_all: bool = typer.Option(False, help="Regenerate Dockerfiles for all services"),
+) -> None:
+    if apply_all:
+        for app_path in APPS_DIR.iterdir():
+            if app_path.is_dir():
+                write_dockerfile(app_path)
+        return
+    if not service:
+        raise typer.BadParameter("Provide --service or --apply-all")
+    app_path = APPS_DIR / service
+    if not app_path.exists():
+        raise typer.BadParameter(f"Unknown service path: {app_path}")
+    write_dockerfile(app_path)
+
+
+if __name__ == "__main__":
+    app()

.infra/config-cli.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Configure local venv for the infra CLI
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+VENV_DIR="$SCRIPT_DIR/.venv"
+PYTHON_BIN="${PYTHON:-python3}"
+
+if [ ! -d "$VENV_DIR" ]; then
+  "$PYTHON_BIN" -m venv "$VENV_DIR"
+fi
+
+# shellcheck disable=SC1091
+source "$VENV_DIR/bin/activate"
+python -m pip install --upgrade pip
+python -m pip install typer
+
+echo "Infra CLI environment ready. Activate with: source $VENV_DIR/bin/activate"

.infra/modules/crm-campaign-intelligence/crm-campaign-intelligence-main.bicep

@@ -0,0 +1,25 @@
+targetScope = 'subscription'
+
+param subscriptionId string = subscription().subscriptionId
+param location string
+param appName string
+param resourceGroupName string = '${appName}-rg'
+param appImage string = 'ghcr.io/OWNER/crm-campaign-intelligence:latest'
+
+resource rg 'Microsoft.Resources/resourceGroups@2021-04-01' = {
+  name: resourceGroupName
+  location: location
+}
+
+module app './crm-campaign-intelligence.bicep' = {
+  name: 'crm-campaign-intelligence-resources'
+  scope: resourceGroup(subscriptionId, resourceGroupName)
+  dependsOn: [
+    rg
+  ]
+  params: {
+    appName: appName
+    location: location
+    appImage: appImage
+  }
+}