|
| 1 | +#!/usr/bin/env bash |
| 2 | + |
| 3 | +# Copyright 2025 The Kubernetes Authors. |
| 4 | +# |
| 5 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | +# you may not use this file except in compliance with the License. |
| 7 | +# You may obtain a copy of the License at |
| 8 | +# |
| 9 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +# |
| 11 | +# Unless required by applicable law or agreed to in writing, software |
| 12 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | +# See the License for the specific language governing permissions and |
| 15 | +# limitations under the License. |
| 16 | + |
| 17 | +set -e |
| 18 | + |
| 19 | +SCRIPT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" |
| 20 | +PROJECT_ROOT="$(cd "${SCRIPT_ROOT}/../.." && pwd)" |
| 21 | + |
| 22 | +# Source the e2e test infrastructure for kind cluster management |
| 23 | +source "${PROJECT_ROOT}/test/common.sh" |
| 24 | +source "${PROJECT_ROOT}/test/e2e/setup.sh" |
| 25 | + |
| 26 | +# Default demo name |
| 27 | +DEMO_NAME="${1:-kb-demo}" |
| 28 | +DEMO_SCRIPT="${2:-${SCRIPT_ROOT}/run.sh}" |
| 29 | + |
| 30 | +# Use color output from common.sh or define our own |
| 31 | +RED='\033[0;31m' |
| 32 | +GREEN='\033[0;32m' |
| 33 | +YELLOW='\033[1;33m' |
| 34 | +NC='\033[0m' # No Color |
| 35 | + |
| 36 | +log() { |
| 37 | + echo -e "${GREEN}[INFO]${NC} $1" |
| 38 | +} |
| 39 | + |
| 40 | +warn() { |
| 41 | + echo -e "${YELLOW}[WARN]${NC} $1" |
| 42 | +} |
| 43 | + |
| 44 | +error() { |
| 45 | + echo -e "${RED}[ERROR]${NC} $1" |
| 46 | + exit 1 |
| 47 | +} |
| 48 | + |
| 49 | +usage() { |
| 50 | + cat << EOF |
| 51 | +Usage: $0 [DEMO_NAME] [DEMO_SCRIPT] |
| 52 | +
|
| 53 | +Generate an asciinema demo recording and convert it to SVG. |
| 54 | +
|
| 55 | +Arguments: |
| 56 | + DEMO_NAME Name of the demo (default: kb-demo) |
| 57 | + DEMO_SCRIPT Path to the demo script to run (default: ${SCRIPT_ROOT}/run.sh) |
| 58 | +
|
| 59 | +Examples: |
| 60 | + $0 # Generate default kb-demo |
| 61 | + $0 my-custom-demo # Generate custom demo with default script |
| 62 | + $0 advanced-demo ./my-demo.sh # Generate custom demo with custom script |
| 63 | +
|
| 64 | +EOF |
| 65 | + exit 0 |
| 66 | +} |
| 67 | + |
| 68 | +check_prerequisites() { |
| 69 | + log "Checking prerequisites..." |
| 70 | + |
| 71 | + # Check for help flag |
| 72 | + if [[ "$1" == "-h" || "$1" == "--help" ]]; then |
| 73 | + usage |
| 74 | + fi |
| 75 | + |
| 76 | + # Validate demo script exists |
| 77 | + if [[ ! -f "$DEMO_SCRIPT" ]]; then |
| 78 | + error "Demo script not found: $DEMO_SCRIPT" |
| 79 | + fi |
| 80 | + |
| 81 | + local missing_tools=() |
| 82 | + |
| 83 | + if ! command -v asciinema &> /dev/null; then |
| 84 | + missing_tools+=("asciinema") |
| 85 | + fi |
| 86 | + |
| 87 | + if ! command -v svg-term &> /dev/null; then |
| 88 | + missing_tools+=("svg-term") |
| 89 | + fi |
| 90 | + |
| 91 | + if ! command -v kind &> /dev/null; then |
| 92 | + missing_tools+=("kind") |
| 93 | + fi |
| 94 | + |
| 95 | + if ! command -v kubectl &> /dev/null; then |
| 96 | + missing_tools+=("kubectl") |
| 97 | + fi |
| 98 | + |
| 99 | + if [ ${#missing_tools[@]} -ne 0 ]; then |
| 100 | + error "Missing required tools:\n$(printf ' - %s\n' "${missing_tools[@]}")" |
| 101 | + fi |
| 102 | + |
| 103 | + log "All prerequisites are installed ✓" |
| 104 | +} |
| 105 | + |
| 106 | +setup_cluster() { |
| 107 | + log "Setting up Kind cluster for demo..." |
| 108 | + |
| 109 | + # Use the e2e infrastructure to set up the cluster |
| 110 | + export KIND_CLUSTER="kubebuilder-demo" |
| 111 | + |
| 112 | + # Build kubebuilder, fetch tools, and install kind if needed |
| 113 | + build_kb |
| 114 | + fetch_tools |
| 115 | + install_kind |
| 116 | + |
| 117 | + # Create the cluster using the e2e setup function |
| 118 | + create_cluster ${KIND_K8S_VERSION} |
| 119 | + |
| 120 | + log "Cluster connection verified ✓" |
| 121 | +} |
| 122 | + |
| 123 | +record_demo() { |
| 124 | + local recording_dir="/tmp/kb-demo-recording" |
| 125 | + |
| 126 | + log "Cleaning up any previous recording files..." |
| 127 | + rm -rf "$recording_dir" |
| 128 | + mkdir -p "$recording_dir" |
| 129 | + |
| 130 | + log "Starting demo recording for '${DEMO_NAME}' in 3 seconds..." |
| 131 | + sleep 3 |
| 132 | + |
| 133 | + cd "$recording_dir" |
| 134 | + asciinema rec \ |
| 135 | + --command "$DEMO_SCRIPT" \ |
| 136 | + --env "DEMO_AUTO_RUN=1" \ |
| 137 | + --title "Kubebuilder Demo: ${DEMO_NAME}" \ |
| 138 | + --idle-time-limit 2 \ |
| 139 | + "${DEMO_NAME}.cast" |
| 140 | +} |
| 141 | + |
| 142 | +convert_to_svg() { |
| 143 | + local recording_dir="/tmp/kb-demo-recording" |
| 144 | + local version="$1" |
| 145 | + local svg_file="${PROJECT_ROOT}/docs/gif/${DEMO_NAME}.${version}.svg" |
| 146 | + |
| 147 | + log "Converting recording to SVG..." |
| 148 | + svg-term \ |
| 149 | + --in="${recording_dir}/${DEMO_NAME}.cast" \ |
| 150 | + --out="$svg_file" \ |
| 151 | + --window \ |
| 152 | + --width=120 \ |
| 153 | + --height=30 |
| 154 | + |
| 155 | + log "Demo updated! New file: docs/gif/${DEMO_NAME}.${version}.svg" |
| 156 | + return 0 |
| 157 | +} |
| 158 | + |
| 159 | +update_readme() { |
| 160 | + local version="$1" |
| 161 | + |
| 162 | + # Only update README for the default kb-demo |
| 163 | + if [[ "$DEMO_NAME" != "kb-demo" ]]; then |
| 164 | + log "Skipping README update for custom demo '${DEMO_NAME}'" |
| 165 | + return 0 |
| 166 | + fi |
| 167 | + |
| 168 | + log "Updating README.md with new demo..." |
| 169 | + if [[ "$OSTYPE" == "darwin"* ]]; then |
| 170 | + # macOS |
| 171 | + sed -i '' "s|docs/gif/kb-demo\.v[^)]*\.svg|docs/gif/kb-demo.${version}.svg|g" "${PROJECT_ROOT}/README.md" |
| 172 | + else |
| 173 | + # Linux |
| 174 | + sed -i "s|docs/gif/kb-demo\.v[^)]*\.svg|docs/gif/kb-demo.${version}.svg|g" "${PROJECT_ROOT}/README.md" |
| 175 | + fi |
| 176 | + |
| 177 | + log "README.md updated with new demo file ✓" |
| 178 | +} |
| 179 | + |
| 180 | +cleanup() { |
| 181 | + log "Cleaning up temporary files..." |
| 182 | + rm -rf /tmp/kb-demo-recording |
| 183 | + log "To clean up the demo cluster, run: make clean-demo" |
| 184 | +} |
| 185 | + |
| 186 | +cleanup_cluster() { |
| 187 | + log "Cleaning up demo cluster..." |
| 188 | + export KIND_CLUSTER="kubebuilder-demo" |
| 189 | + delete_cluster |
| 190 | + log "Demo cluster removed ✓" |
| 191 | +} |
| 192 | + |
| 193 | +main() { |
| 194 | + # Check for help flag first |
| 195 | + if [[ "$1" == "-h" || "$1" == "--help" ]]; then |
| 196 | + usage |
| 197 | + fi |
| 198 | + |
| 199 | + log "Starting Kubebuilder demo generation for '${DEMO_NAME}'..." |
| 200 | + log "Using demo script: ${DEMO_SCRIPT}" |
| 201 | + |
| 202 | + # Extract version once to avoid duplication |
| 203 | + local version |
| 204 | + version=$(git -C "$PROJECT_ROOT" describe --tags --abbrev=0 2>/dev/null || echo "v4.0.0") |
| 205 | + |
| 206 | + check_prerequisites |
| 207 | + setup_cluster |
| 208 | + record_demo |
| 209 | + convert_to_svg "$version" |
| 210 | + update_readme "$version" |
| 211 | + cleanup |
| 212 | + |
| 213 | + log "Demo generation completed successfully! 🎉" |
| 214 | + log "Generated: docs/gif/${DEMO_NAME}.${version}.svg" |
| 215 | +} |
| 216 | + |
| 217 | +main "$@" |
0 commit comments