|
| 1 | +#!/usr/bin/env node |
| 2 | + |
| 3 | +const fs = require("fs"); |
| 4 | +const os = require("os"); |
| 5 | +const path = require("path"); |
| 6 | +const { spawnSync } = require("child_process"); |
| 7 | + |
| 8 | +const root = __dirname; |
| 9 | +const courseDir = path.join(root, "course"); |
| 10 | +const statesFile = path.join(courseDir, "states.yml"); |
| 11 | +const overlaysDir = path.join(courseDir, "overlays"); |
| 12 | + |
| 13 | +function usage() { |
| 14 | + console.log(`Usage: |
| 15 | + ./course-state list |
| 16 | + ./course-state create <state> <target-dir> |
| 17 | + ./course-state test <state> [--skip-slow] |
| 18 | + ./course-state validate [--skip-slow]`); |
| 19 | +} |
| 20 | + |
| 21 | +function parseStates() { |
| 22 | + const lines = fs.readFileSync(statesFile, "utf8").split(/\r?\n/); |
| 23 | + const states = {}; |
| 24 | + let current = null; |
| 25 | + let listKey = null; |
| 26 | + |
| 27 | + for (const line of lines) { |
| 28 | + if (!line.trim() || line.trim().startsWith("#") || line.trim() === "states:") { |
| 29 | + continue; |
| 30 | + } |
| 31 | + |
| 32 | + const stateMatch = line.match(/^ ([a-z0-9-]+):\s*$/); |
| 33 | + if (stateMatch) { |
| 34 | + current = { overlays: [], tests: [], expectedFailures: [] }; |
| 35 | + states[stateMatch[1]] = current; |
| 36 | + listKey = null; |
| 37 | + continue; |
| 38 | + } |
| 39 | + |
| 40 | + if (!current) { |
| 41 | + continue; |
| 42 | + } |
| 43 | + |
| 44 | + const keyMatch = line.match(/^ ([A-Za-z]+):(?:\s*(.*))?$/); |
| 45 | + if (keyMatch) { |
| 46 | + const key = keyMatch[1]; |
| 47 | + const value = (keyMatch[2] || "").trim(); |
| 48 | + listKey = null; |
| 49 | + |
| 50 | + if (["overlays", "tests", "expectedFailures"].includes(key)) { |
| 51 | + listKey = key; |
| 52 | + if (value === "[]") { |
| 53 | + current[key] = []; |
| 54 | + listKey = null; |
| 55 | + } |
| 56 | + continue; |
| 57 | + } |
| 58 | + |
| 59 | + if (key === "description" || key === "extends") { |
| 60 | + current[key] = unquote(value); |
| 61 | + } |
| 62 | + continue; |
| 63 | + } |
| 64 | + |
| 65 | + const itemMatch = line.match(/^ -\s*(.*)$/); |
| 66 | + if (itemMatch && listKey) { |
| 67 | + current[listKey].push(unquote(itemMatch[1].trim())); |
| 68 | + } |
| 69 | + } |
| 70 | + |
| 71 | + return states; |
| 72 | +} |
| 73 | + |
| 74 | +function unquote(value) { |
| 75 | + return value.replace(/^["']|["']$/g, ""); |
| 76 | +} |
| 77 | + |
| 78 | +function resolveState(states, name, seen = new Set()) { |
| 79 | + const state = states[name]; |
| 80 | + if (!state) { |
| 81 | + throw new Error(`Unknown state: ${name}`); |
| 82 | + } |
| 83 | + if (seen.has(name)) { |
| 84 | + throw new Error(`Cycle in course state definitions at ${name}`); |
| 85 | + } |
| 86 | + seen.add(name); |
| 87 | + |
| 88 | + if (!state.extends) { |
| 89 | + return { ...state, overlays: [...state.overlays] }; |
| 90 | + } |
| 91 | + |
| 92 | + const parent = resolveState(states, state.extends, seen); |
| 93 | + return { |
| 94 | + ...state, |
| 95 | + overlays: [...parent.overlays, ...state.overlays], |
| 96 | + tests: state.tests.length ? state.tests : parent.tests, |
| 97 | + expectedFailures: state.expectedFailures.length ? state.expectedFailures : parent.expectedFailures, |
| 98 | + }; |
| 99 | +} |
| 100 | + |
| 101 | +function copyProject(target) { |
| 102 | + const resolvedTarget = path.resolve(target); |
| 103 | + if (resolvedTarget === root || resolvedTarget.startsWith(root + path.sep)) { |
| 104 | + throw new Error("Target directory must be outside db-2-app."); |
| 105 | + } |
| 106 | + fs.rmSync(resolvedTarget, { recursive: true, force: true }); |
| 107 | + fs.mkdirSync(resolvedTarget, { recursive: true }); |
| 108 | + copyDir(root, resolvedTarget, new Set([".git", "target", ".idea", ".vscode"])); |
| 109 | +} |
| 110 | + |
| 111 | +function copyDir(source, target, excludedNames = new Set()) { |
| 112 | + for (const entry of fs.readdirSync(source, { withFileTypes: true })) { |
| 113 | + if (excludedNames.has(entry.name)) { |
| 114 | + continue; |
| 115 | + } |
| 116 | + const sourcePath = path.join(source, entry.name); |
| 117 | + const targetPath = path.join(target, entry.name); |
| 118 | + if (entry.isDirectory()) { |
| 119 | + fs.mkdirSync(targetPath, { recursive: true }); |
| 120 | + copyDir(sourcePath, targetPath, excludedNames); |
| 121 | + } else if (entry.isSymbolicLink()) { |
| 122 | + fs.symlinkSync(fs.readlinkSync(sourcePath), targetPath); |
| 123 | + } else { |
| 124 | + fs.copyFileSync(sourcePath, targetPath); |
| 125 | + } |
| 126 | + } |
| 127 | +} |
| 128 | + |
| 129 | +function applyOverlay(target, overlay) { |
| 130 | + const overlayPath = path.join(overlaysDir, overlay); |
| 131 | + if (!fs.existsSync(overlayPath)) { |
| 132 | + throw new Error(`Missing overlay: ${overlay}`); |
| 133 | + } |
| 134 | + copyDir(overlayPath, target); |
| 135 | +} |
| 136 | + |
| 137 | +function createState(name, target) { |
| 138 | + const states = parseStates(); |
| 139 | + const state = resolveState(states, name); |
| 140 | + const resolvedTarget = path.resolve(target); |
| 141 | + copyProject(resolvedTarget); |
| 142 | + for (const overlay of state.overlays) { |
| 143 | + applyOverlay(resolvedTarget, overlay); |
| 144 | + } |
| 145 | + fs.writeFileSync( |
| 146 | + path.join(resolvedTarget, "COURSE_STATE.md"), |
| 147 | + `# ${name}\n\n${state.description || ""}\n\nApplied overlays: ${state.overlays.join(", ") || "none"}\n`, |
| 148 | + "utf8" |
| 149 | + ); |
| 150 | + console.log(`Created ${name} at ${resolvedTarget}`); |
| 151 | +} |
| 152 | + |
| 153 | +function validate(skipSlow) { |
| 154 | + const states = parseStates(); |
| 155 | + const baseTempDir = fs.existsSync("/tmp") ? "/tmp" : os.tmpdir(); |
| 156 | + const tempRoot = fs.mkdtempSync(path.join(baseTempDir, "db-2-app-states-")); |
| 157 | + try { |
| 158 | + for (const name of Object.keys(states)) { |
| 159 | + testState(name, path.join(tempRoot, name), skipSlow); |
| 160 | + } |
| 161 | + } finally { |
| 162 | + fs.rmSync(tempRoot, { recursive: true, force: true }); |
| 163 | + } |
| 164 | +} |
| 165 | + |
| 166 | +function testState(name, target, skipSlow) { |
| 167 | + const states = parseStates(); |
| 168 | + const state = resolveState(states, name); |
| 169 | + createState(name, target); |
| 170 | + runCommands(name, target, state.tests, false, skipSlow); |
| 171 | + runCommands(name, target, state.expectedFailures || [], true, skipSlow); |
| 172 | +} |
| 173 | + |
| 174 | +function runCommands(stateName, cwd, commands, expectedFailure, skipSlow) { |
| 175 | + for (const command of commands) { |
| 176 | + if (skipSlow && command.includes("-Ptestcontainers")) { |
| 177 | + console.log(`[${stateName}] skip slow command: ${command}`); |
| 178 | + continue; |
| 179 | + } |
| 180 | + console.log(`[${stateName}] ${expectedFailure ? "expect failure: " : ""}${command}`); |
| 181 | + const result = spawnSync(command, { |
| 182 | + cwd, |
| 183 | + shell: true, |
| 184 | + stdio: "inherit", |
| 185 | + }); |
| 186 | + const failed = result.status !== 0; |
| 187 | + if (expectedFailure ? !failed : failed) { |
| 188 | + throw new Error(`[${stateName}] Unexpected result for: ${command}`); |
| 189 | + } |
| 190 | + } |
| 191 | +} |
| 192 | + |
| 193 | +const [command, ...args] = process.argv.slice(2); |
| 194 | + |
| 195 | +try { |
| 196 | + if (command === "list") { |
| 197 | + for (const [name, state] of Object.entries(parseStates())) { |
| 198 | + console.log(`${name}: ${state.description || ""}`); |
| 199 | + } |
| 200 | + } else if (command === "create") { |
| 201 | + if (args.length !== 2) { |
| 202 | + usage(); |
| 203 | + process.exit(1); |
| 204 | + } |
| 205 | + createState(args[0], args[1]); |
| 206 | + } else if (command === "test") { |
| 207 | + const stateName = args.find((arg) => !arg.startsWith("--")); |
| 208 | + if (!stateName) { |
| 209 | + usage(); |
| 210 | + process.exit(1); |
| 211 | + } |
| 212 | + const baseTempDir = fs.existsSync("/tmp") ? "/tmp" : os.tmpdir(); |
| 213 | + const target = fs.mkdtempSync(path.join(baseTempDir, `db-2-app-${stateName}-`)); |
| 214 | + try { |
| 215 | + testState(stateName, target, args.includes("--skip-slow")); |
| 216 | + } finally { |
| 217 | + fs.rmSync(target, { recursive: true, force: true }); |
| 218 | + } |
| 219 | + } else if (command === "validate") { |
| 220 | + validate(args.includes("--skip-slow")); |
| 221 | + } else { |
| 222 | + usage(); |
| 223 | + process.exit(command ? 1 : 0); |
| 224 | + } |
| 225 | +} catch (error) { |
| 226 | + console.error(error.message); |
| 227 | + process.exit(1); |
| 228 | +} |
0 commit comments