superset-showtime 0.2.6__py3-none-any.whl → 0.2.8__py3-none-any.whl

showtime/__init__.py

@@ -4,7 +4,7 @@
 Circus tent emoji state tracking for Apache Superset ephemeral environments.
 """
 
-__version__ = "0.2.6"
+__version__ = "0.2.8"
 __author__ = "Maxime Beauchemin"
 __email__ = "maximebeauchemin@gmail.com"
 

showtime/cli.py

@@ -10,9 +10,17 @@ import typer
 from rich.console import Console
 from rich.table import Table
 
-from .core.circus import PullRequest, Show
+from .core.circus import PullRequest, Show, short_sha
 from .core.emojis import STATUS_DISPLAY
 from .core.github import GitHubError, GitHubInterface
+from .core.github_messages import (
+    get_aws_console_urls,
+    rolling_failure_comment,
+    rolling_start_comment,
+    rolling_success_comment,
+    start_comment,
+    success_comment,
+)
 
 # Constants
 DEFAULT_GITHUB_ACTOR = "unknown"
@@ -20,13 +28,7 @@ DEFAULT_GITHUB_ACTOR = "unknown"
 
 def _get_service_urls(show):
     """Get AWS Console URLs for a service"""
-    service_name = show.ecs_service_name
-
-    return {
-        "logs": f"https://us-west-2.console.aws.amazon.com/ecs/v2/clusters/superset-ci/services/{service_name}/logs?region=us-west-2",
-        "service": f"https://us-west-2.console.aws.amazon.com/ecs/v2/clusters/superset-ci/services/{service_name}?region=us-west-2",
-        "health": f"https://us-west-2.console.aws.amazon.com/ecs/v2/clusters/superset-ci/services/{service_name}/health?region=us-west-2",
-    }
+    return get_aws_console_urls(show.ecs_service_name)
 
 
 def _show_service_urls(show, context: str = "deployment"):
@@ -152,6 +154,28 @@ app = typer.Typer(
 console = Console()
 
 
+def _get_github_workflow_url() -> str:
+    """Get current GitHub Actions workflow URL"""
+    import os
+
+    return (
+        os.getenv("GITHUB_SERVER_URL", "https://github.com")
+        + f"/{os.getenv('GITHUB_REPOSITORY', 'repo')}/actions/runs/{os.getenv('GITHUB_RUN_ID', 'run')}"
+    )
+
+
+def _get_github_actor() -> str:
+    """Get current GitHub actor with fallback"""
+    import os
+
+    return os.getenv("GITHUB_ACTOR", DEFAULT_GITHUB_ACTOR)
+
+
+def _get_showtime_footer() -> str:
+    """Get consistent Showtime footer for PR comments"""
+    return "{_get_showtime_footer()}"
+
+
 @app.command()
 def version():
     """Show version information"""
@@ -1041,7 +1065,6 @@ def _handle_start_trigger(
     force: bool = False,
 ):
     """Handle start trigger"""
-    import os
     import time
     from datetime import datetime
 
@@ -1050,29 +1073,12 @@ def _handle_start_trigger(
     try:
         # Get latest SHA and GitHub actor
         latest_sha = github.get_latest_commit_sha(pr_number)
-        github_actor = os.getenv("GITHUB_ACTOR", DEFAULT_GITHUB_ACTOR)
-
-        # Post confirmation comment
-        workflow_url = (
-            os.getenv("GITHUB_SERVER_URL", "https://github.com")
-            + f"/{os.getenv('GITHUB_REPOSITORY', 'repo')}/actions/runs/{os.getenv('GITHUB_RUN_ID', 'run')}"
-        )
-
-        confirmation_comment = f"""🎪 @{github_actor} Creating ephemeral environment for commit `{latest_sha[:7]}`
-
-**Action:** [View workflow]({workflow_url})
-**Environment:** `{latest_sha[:7]}`
-**Powered by:** [Superset Showtime](https://github.com/mistercrunch/superset-showtime)
-
-*Building and deploying... Watch the labels for progress updates.*"""
-
-        if not dry_run_github:
-            github.post_comment(pr_number, confirmation_comment)
+        github_actor = _get_github_actor()
 
         # Create new show
         show = Show(
             pr_number=pr_number,
-            sha=latest_sha[:7],
+            sha=short_sha(latest_sha),
             status="building",
             created_at=datetime.utcnow().strftime("%Y-%m-%dT%H-%M"),
             ttl="24h",
@@ -1081,6 +1087,12 @@ def _handle_start_trigger(
 
         console.print(f"🎪 Creating environment {show.aws_service_name}")
 
+        # Post confirmation comment
+        confirmation_comment = start_comment(show)
+
+        if not dry_run_github:
+            github.post_comment(pr_number, confirmation_comment)
+
         # Set building state labels
         building_labels = show.to_circus_labels()
         console.print("🎪 Setting building state labels:")
@@ -1136,19 +1148,19 @@ def _handle_start_trigger(
                 )
 
             # Post success comment (only in dry-run-aws mode since we have mock IP)
-            success_comment = f"""🎪 @{github_actor} Environment ready at **http://{mock_ip}:8080**
-
-**Environment:** `{show.sha}`
-**Credentials:** admin / admin
-**TTL:** {show.ttl} (auto-cleanup)
-
-**Configuration:** Modify feature flags in your PR code for new SHA
-**Updates:** Environment updates automatically on new commits
-
-*Powered by [Superset Showtime](https://github.com/mistercrunch/superset-showtime)*"""
+            # Create mock show with IP for success comment
+            mock_show = Show(
+                pr_number=show.pr_number,
+                sha=show.sha,
+                status="running",
+                ip=mock_ip,
+                ttl=show.ttl,
+                requested_by=show.requested_by,
+            )
+            success_comment_text = success_comment(mock_show)
 
             if not dry_run_github:
-                github.post_comment(pr_number, success_comment)
+                github.post_comment(pr_number, success_comment_text)
 
         else:
             # Real AWS operations
@@ -1246,19 +1258,12 @@ def _handle_start_trigger(
                     console.print("🎪 ✅ Labels updated to running state!")
 
                     # Post success comment with real IP
-                    success_comment = f"""🎪 @{github_actor} Environment ready at **http://{result.ip}:8080**
-
-**Environment:** `{show.sha}`
-**Credentials:** admin / admin
-**TTL:** {show.ttl} (auto-cleanup)
-**Feature flags:** {len(feature_flags)} enabled
+                    # Update show with real IP for comment
+                    show.ip = result.ip
+                    show.status = "running"
+                    success_comment_text = success_comment(show, feature_count=len(feature_flags))
 
-**Configuration:** Modify feature flags in your PR code for new SHA
-**Updates:** Environment updates automatically on new commits
-
-*Powered by [Superset Showtime](https://github.com/mistercrunch/superset-showtime)*"""
-
-                    github.post_comment(pr_number, success_comment)
+                    github.post_comment(pr_number, success_comment_text)
 
             else:
                 console.print(f"🎪 [bold red]❌ AWS deployment failed:[/bold red] {result.error}")
@@ -1281,7 +1286,7 @@ def _handle_start_trigger(
 
 Please check the logs and try again.
 
-*Powered by [Superset Showtime](https://github.com/mistercrunch/superset-showtime)*"""
+{_get_showtime_footer()}"""
 
                     github.post_comment(pr_number, failure_comment)
 
@@ -1320,7 +1325,6 @@ def _handle_stop_trigger(
     pr_number: int, github: GitHubInterface, dry_run_aws: bool = False, dry_run_github: bool = False
 ):
     """Handle stop trigger"""
-    import os
 
     console.print(f"🎪 Stopping environment for PR #{pr_number}")
 
@@ -1396,7 +1400,7 @@ def _handle_stop_trigger(
             github.remove_circus_labels(pr_number)
 
         # Post cleanup comment
-        github_actor = os.getenv("GITHUB_ACTOR", DEFAULT_GITHUB_ACTOR)
+        github_actor = _get_github_actor()
         cleanup_comment = f"""🎪 @{github_actor} Environment `{show.sha}` cleaned up
 
 **AWS Resources:** ECS service and ECR image deleted
@@ -1404,7 +1408,7 @@ def _handle_stop_trigger(
 
 Add `🎪 trigger-start` to create a new environment.
 
-*Powered by [Superset Showtime](https://github.com/mistercrunch/superset-showtime)*"""
+{_get_showtime_footer()}"""
 
         if not dry_run_github:
             github.post_comment(pr_number, cleanup_comment)
@@ -1477,14 +1481,73 @@ def _handle_sync_trigger(
 
 Your latest changes are now live.
 
-*Powered by [Superset Showtime](https://github.com/mistercrunch/superset-showtime)*"""
+{_get_showtime_footer()}"""
 
             if not dry_run_github:
                 github.post_comment(pr_number, update_comment)
 
         else:
-            # TODO: Real rolling update
-            console.print("🎪 [bold yellow]Real rolling update not yet implemented[/bold yellow]")
+            # Real rolling update - use same blue-green deployment logic
+
+            from .core.aws import AWSInterface, EnvironmentResult
+
+            console.print("🎪 [bold blue]Starting real rolling update...[/bold blue]")
+
+            # Post rolling update start comment
+            start_comment_text = rolling_start_comment(pr.current_show, latest_sha)
+
+            if not dry_run_github:
+                github.post_comment(pr_number, start_comment_text)
+
+            aws = AWSInterface()
+
+            # Get feature flags from PR description
+            feature_flags = _extract_feature_flags_from_pr(pr_number, github)
+            github_actor = _get_github_actor()
+
+            # Use blue-green deployment (create_environment handles existing services)
+            result: EnvironmentResult = aws.create_environment(
+                pr_number=pr_number,
+                sha=latest_sha,
+                github_user=github_actor,
+                feature_flags=feature_flags,
+                force=False,  # Don't force - let blue-green handle it
+            )
+
+            if result.success:
+                console.print(
+                    f"🎪 [bold green]✅ Rolling update complete![/bold green] New IP: {result.ip}"
+                )
+
+                # Update labels to point to new service
+                pr.refresh_labels(github)
+                new_show = pr.get_show_by_sha(latest_sha)
+                if new_show:
+                    new_show.status = "running"
+                    new_show.ip = result.ip
+
+                    # Update GitHub labels
+                    github.remove_circus_labels(pr_number)
+                    for label in new_show.to_circus_labels():
+                        github.add_label(pr_number, label)
+
+                    console.print("🎪 ✅ Labels updated to point to new environment")
+
+                    # Post rolling update success comment
+                    success_comment_text = rolling_success_comment(pr.current_show, new_show)
+
+                    if not dry_run_github:
+                        github.post_comment(pr_number, success_comment_text)
+            else:
+                console.print(f"🎪 [bold red]❌ Rolling update failed:[/bold red] {result.error}")
+
+                # Post rolling update failure comment
+                failure_comment_text = rolling_failure_comment(
+                    pr.current_show, latest_sha, result.error
+                )
+
+                if not dry_run_github:
+                    github.post_comment(pr_number, failure_comment_text)
 
     except Exception as e:
         console.print(f"🎪 [bold red]Sync trigger failed:[/bold red] {e}")

showtime/core/circus.py

@@ -39,6 +39,11 @@ class Show:
         """Deterministic ECS service name with -service suffix: pr-{pr_number}-{sha}-service"""
         return f"{self.aws_service_name}-service"
 
+    @property
+    def short_sha(self) -> str:
+        """7-character SHA for display (GitHub standard)"""
+        return self.sha[:7]
+
     @property
     def is_active(self) -> bool:
         """Check if this is the currently active show"""
@@ -267,3 +272,8 @@ def get_effective_ttl(pr) -> Optional[float]:
 
     # Use longest duration if multiple labels
     return max(ttl_labels)
+
+
+def short_sha(full_sha: str) -> str:
+    """Truncate SHA to 7 characters for display (GitHub standard)"""
+    return full_sha[:7]

showtime/core/github_messages.py

@@ -0,0 +1,227 @@
+"""
+🎪 GitHub PR comment templates and messaging utilities
+
+Centralized PR comment functions with type hints and clean formatting.
+"""
+
+import os
+import textwrap
+from typing import Dict, List, Optional
+
+from .circus import Show
+
+# AWS Console URL constants
+BASE_AWS_URL = "https://us-west-2.console.aws.amazon.com/ecs/v2/clusters/superset-ci/services"
+AWS_REGION = "us-west-2"
+
+
+def get_github_actor() -> str:
+    """Get current GitHub actor with fallback"""
+    return os.getenv("GITHUB_ACTOR", "unknown")
+
+
+def get_github_workflow_url() -> str:
+    """Get current GitHub Actions workflow URL"""
+    return (
+        os.getenv("GITHUB_SERVER_URL", "https://github.com")
+        + f"/{os.getenv('GITHUB_REPOSITORY', 'repo')}/actions/runs/{os.getenv('GITHUB_RUN_ID', 'run')}"
+    )
+
+
+def get_showtime_footer() -> str:
+    """Get consistent Showtime footer for PR comments"""
+    return "*Powered by [Superset Showtime](https://github.com/mistercrunch/superset-showtime)*"
+
+
+def _create_header_links(sha: str) -> Dict[str, str]:
+    """Create standard header links for comments
+
+    Args:
+        sha: Commit SHA for the environment
+
+    Returns:
+        Dict with showtime_link, gha_link, commit_link
+    """
+    from .circus import short_sha
+
+    repo_path = get_repo_path()
+    return {
+        "showtime_link": "[Showtime](https://github.com/mistercrunch/superset-showtime)",
+        "gha_link": f"[GHA]({get_github_workflow_url()})",
+        "commit_link": f"[{short_sha(sha)}]({get_commit_url(repo_path, sha)})",
+    }
+
+
+def _format_comment(header: str, bullets: List[str]) -> str:
+    """Format comment with header and bullet points
+
+    Args:
+        header: Comment header text
+        bullets: List of bullet point strings (without •)
+    """
+    bullet_text = "\n".join(f"• {bullet}" for bullet in bullets)
+    return textwrap.dedent(
+        f"""
+        {header}
+
+        {bullet_text}
+    """
+    ).strip()
+
+
+def get_commit_url(repo_path: str, sha: str) -> str:
+    """Get GitHub commit URL
+
+    Args:
+        repo_path: Repository path like 'apache/superset'
+        sha: Full or short commit SHA
+    """
+    return f"https://github.com/{repo_path}/commit/{sha}"
+
+
+def get_repo_path() -> str:
+    """Get current repository path from environment"""
+    return os.getenv("GITHUB_REPOSITORY", "apache/superset")
+
+
+def get_aws_console_urls(service_name: str) -> Dict[str, str]:
+    """Get AWS Console URLs for a service"""
+    return {
+        "logs": f"{BASE_AWS_URL}/{service_name}/logs?region={AWS_REGION}",
+        "service": f"{BASE_AWS_URL}/{service_name}?region={AWS_REGION}",
+        "health": f"{BASE_AWS_URL}/{service_name}/health?region={AWS_REGION}",
+    }
+
+
+# Typed comment functions with clear parameter requirements
+
+
+def start_comment(show: Show) -> str:
+    """Create environment start comment
+
+    Args:
+        show: Show object with SHA and other metadata
+    """
+    links = _create_header_links(show.sha)
+    return f"🎪 {links['showtime_link']} is building environment on {links['gha_link']} for {links['commit_link']}"
+
+
+def success_comment(show: Show, feature_count: Optional[int] = None) -> str:
+    """Environment success comment
+
+    Args:
+        show: Show object with SHA, IP, TTL, etc.
+        feature_count: Number of enabled feature flags (optional)
+    """
+    links = _create_header_links(show.sha)
+    header = f"🎪 {links['showtime_link']} deployed environment on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Environment:** http://{show.ip}:8080 (admin/admin)",
+        f"**Lifetime:** {show.ttl} auto-cleanup",
+    ]
+
+    if feature_count:
+        bullets.insert(-1, f"**Features:** {feature_count} enabled")
+
+    bullets.append("**Updates:** New commits create fresh environments automatically")
+
+    return _format_comment(header, bullets)
+
+
+def failure_comment(show: Show, error: str) -> str:
+    """Environment failure comment
+
+    Args:
+        show: Show object with SHA and metadata
+        error: Error message describing what went wrong
+    """
+    links = _create_header_links(show.sha)
+    header = f"🎪 {links['showtime_link']} failed building environment on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Error:** {error}",
+        "**Action:** Check logs and try again with `🎪 ⚡ showtime-trigger-start`",
+    ]
+
+    return _format_comment(header, bullets)
+
+
+def cleanup_comment(show: Show) -> str:
+    """Environment cleanup comment
+
+    Args:
+        show: Show object with SHA and metadata
+    """
+    links = _create_header_links(show.sha)
+    header = f"🎪 {links['showtime_link']} cleaned up environment on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        "**Resources:** ECS service and ECR image deleted",
+        "**Cost:** No further charges",
+        "**Action:** Add `🎪 ⚡ showtime-trigger-start` to create new environment",
+    ]
+
+    return _format_comment(header, bullets)
+
+
+def rolling_start_comment(current_show: Show, new_sha: str) -> str:
+    """Rolling update start comment
+
+    Args:
+        current_show: Current Show object with SHA and IP
+        new_sha: New environment SHA (full SHA, will be truncated)
+    """
+    from .circus import short_sha
+
+    links = _create_header_links(new_sha)
+    header = f"🎪 {links['showtime_link']} is updating {current_show.short_sha}→{short_sha(new_sha)} on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Current:** http://{current_show.ip}:8080 (still active)",
+        "**Update:** Zero-downtime blue-green deployment",
+    ]
+
+    return _format_comment(header, bullets)
+
+
+def rolling_success_comment(old_show: Show, new_show: Show) -> str:
+    """Rolling update success comment
+
+    Args:
+        old_show: Previous Show object
+        new_show: New Show object with updated IP, SHA, TTL
+    """
+    links = _create_header_links(new_show.sha)
+    header = f"🎪 {links['showtime_link']} updated environment {old_show.short_sha}→{new_show.short_sha} on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Environment:** http://{new_show.ip}:8080 (admin/admin)",
+        f"**Lifetime:** {new_show.ttl} auto-cleanup",
+        "**Deployment:** Zero-downtime blue-green",
+        "**Updates:** New commits create fresh environments automatically",
+    ]
+
+    return _format_comment(header, bullets)
+
+
+def rolling_failure_comment(current_show: Show, new_sha: str, error: str) -> str:
+    """Rolling update failure comment
+
+    Args:
+        current_show: Current Show object (still active)
+        new_sha: Failed new environment SHA (full SHA, will be truncated)
+        error: Error message describing what went wrong
+    """
+    from .circus import short_sha
+
+    links = _create_header_links(new_sha)
+    header = f"🎪 {links['showtime_link']} failed updating to {short_sha(new_sha)} on {links['gha_link']} for {links['commit_link']}"
+
+    bullets = [
+        f"**Error:** {error}",
+        f"**Current:** http://{current_show.ip}:8080 (still active)",
+        "**Action:** Check logs and try again with `🎪 ⚡ showtime-trigger-start`",
+    ]
+
+    return _format_comment(header, bullets)

{superset_showtime-0.2.6.dist-info → superset_showtime-0.2.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: superset-showtime
-Version: 0.2.6
+Version: 0.2.8
 Summary: 🎪 Apache Superset ephemeral environment management with circus tent emoji state tracking
 Project-URL: Homepage, https://github.com/apache/superset-showtime
 Project-URL: Documentation, https://superset-showtime.readthedocs.io/

{superset_showtime-0.2.6.dist-info → superset_showtime-0.2.8.dist-info}/RECORD

@@ -1,16 +1,17 @@
-showtime/__init__.py,sha256=Zky8z5S5Bal-wfTvrhiFEy-pKkoQ2WZW59PZ-edvsGE,420
+showtime/__init__.py,sha256=1wse0Q42I1-_VwF1AYaIDYvkqx4eC32omodFrMeStlE,420
 showtime/__main__.py,sha256=EVaDaTX69yIhCzChg99vqvFSCN4ELstEt7Mpb9FMZX8,109
-showtime/cli.py,sha256=fd-BfhZgRCdXx85ckZNcIgzNBeH5T9bVuGMtpfF3zr4,61169
+showtime/cli.py,sha256=gd8OIjdQov7ei8A9A2X8bdreOeWJVhc5FFhAN9u_spQ,62913
 showtime/commands/__init__.py,sha256=M2wn5hYgwNCryMjLT79ncobvK884r-xk3znkCmINN_0,28
 showtime/commands/start.py,sha256=DPGbgvGPh7I60LK_VioDljUhdmhNFVjEy6BchFv1lCo,1026
 showtime/core/__init__.py,sha256=54hbdFNGrzuNMBdraezfjT8Zi6g221pKlJ9mREnKwCw,34
 showtime/core/aws.py,sha256=xWrje3MS3LpFeilH6jloWy_VgE9Wky_G5VkRCOB0ZNw,32535
-showtime/core/circus.py,sha256=c7eKHZ4CzB03IN2pEuuqcDT_mp_RLqPHl-68pzPbJi8,8770
+showtime/core/circus.py,sha256=dtYEU1YnmaE9oWhPwrPiMof1GF5tzckvcDrc9iJ9VpQ,9037
 showtime/core/emojis.py,sha256=MHEDuPIdfNiop4zbNLuviz3eY05QiftYSHHCVbkfKhw,2129
 showtime/core/github.py,sha256=HWhM8_Yq4P-AHq0FV3UfrfQHUHXxkhn74vvc_9RguKA,9822
+showtime/core/github_messages.py,sha256=iKd3AS0uvTnCtR-2jPtEq_efuThC8HUzEAMmQt5c3y4,7187
 showtime/core/label_colors.py,sha256=efhbFnz_3nqEnEqmgyF6_hZbxtCu_fmb68BIIUpSsnk,3895
 showtime/data/ecs-task-definition.json,sha256=0ZaE0FZ8IWduXd2RyscMhXeVgxyym6qtjH02CK9mXBI,2235
-superset_showtime-0.2.6.dist-info/METADATA,sha256=5fK6P2GZXuzC17NC5K3gmHQajjIM_gvXKaRXhG62ACs,14635
-superset_showtime-0.2.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-superset_showtime-0.2.6.dist-info/entry_points.txt,sha256=rDW7oZ57mqyBUS4N_3_R7bZNGVHB-104jwmY-hHC_ck,85
-superset_showtime-0.2.6.dist-info/RECORD,,
+superset_showtime-0.2.8.dist-info/METADATA,sha256=fMZkdKW3pgcxx-AXRP5rmTpmOBLEXtVcSaLr2L5A7xg,14635
+superset_showtime-0.2.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+superset_showtime-0.2.8.dist-info/entry_points.txt,sha256=rDW7oZ57mqyBUS4N_3_R7bZNGVHB-104jwmY-hHC_ck,85
+superset_showtime-0.2.8.dist-info/RECORD,,