@electriccitizen/bolt 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,178 @@
+/**
+ * Shared interfaces for the Bolt test runner.
+ */
+import type { Browser, BrowserContext } from 'playwright';
+export interface FieldDefinition {
+    name: string;
+    label: string;
+    type: string;
+    required: boolean;
+    cardinality: number;
+    settings: Record<string, unknown>;
+}
+export interface ContentTypeDefinition {
+    id: string;
+    label: string;
+    fields: FieldDefinition[];
+}
+export interface ParagraphBundle {
+    id: string;
+    label: string;
+    fields: FieldDefinition[];
+}
+export interface MenuItem {
+    title: string;
+    url: string;
+}
+export interface MenuDefinition {
+    name: string;
+    items: MenuItem[];
+}
+export interface RepresentativeUrl {
+    url: string;
+    source: 'homepage' | 'menu' | 'content_type' | 'view' | 'custom';
+    label: string;
+    contentType?: string;
+    viewId?: string;
+    displayId?: string;
+}
+export interface SiteProfile {
+    boltInspectVersion?: string;
+    contentTypes: ContentTypeDefinition[];
+    paragraphBundles: ParagraphBundle[];
+    enabledModules: string[];
+    routes: string[];
+    mediaTypes: string[];
+    menus: MenuDefinition[];
+    representativeUrls: RepresentativeUrl[];
+}
+export interface TestResult {
+    plugin: string;
+    test: string;
+    status: 'pass' | 'fail' | 'skip' | 'warn' | 'suppressed';
+    severity: 'critical' | 'major' | 'minor' | 'info';
+    message?: string;
+    screenshot?: string;
+    duration: number;
+}
+export interface TestContext {
+    siteUrl: string;
+    browser: Browser;
+    browserContext: BrowserContext;
+    profile: SiteProfile;
+    adapter: HostingAdapter;
+    mode: ExecutionMode;
+    options: TestOptions;
+}
+export interface TestPlugin {
+    name: string;
+    description: string;
+    requiredModules?: string[];
+    dependsOn?: string[];
+    readOnly?: boolean;
+    needsGeneratedContent?: boolean;
+    canRun(profile: SiteProfile): boolean;
+    run(ctx: TestContext): Promise<TestResult[]>;
+}
+export interface CommandResult {
+    stdout: string;
+    stderr: string;
+    exitCode: number;
+}
+export interface HostingAdapter {
+    name: string;
+    canConnect(siteUrl: string): Promise<boolean>;
+    drush(command: string, args?: string[]): Promise<CommandResult>;
+    composer(command: string, args?: string[]): Promise<CommandResult>;
+    getLoginUrl(siteUrl: string): Promise<string>;
+}
+export type ExecutionMode = 'full' | 'read-only' | 'admin-only';
+export type Severity = 'critical' | 'major' | 'minor' | 'info';
+export interface TestOptions {
+    url: string;
+    mode: ExecutionMode;
+    plugins?: string[];
+    output: 'text' | 'json' | 'markdown';
+    report?: string;
+    exitCode: boolean;
+    failOn: Severity;
+    headed: boolean;
+    screenshots?: string;
+    /** Visual regression baseline directory */
+    vrBaseline?: string;
+    /** Visual regression diff threshold percentage */
+    vrThreshold?: number;
+    /** Content types to limit testing to */
+    contentTypes?: string[];
+    /** Plugins to skip (from .bolt.yml) */
+    configSkip?: string[];
+    /** Full .bolt.yml config (passed through for runner/plugin access) */
+    boltConfig?: import('./config.js').BoltConfig;
+    /** Skip .boltrc.yml suppression (used by `bolt suppress` to see raw failures) */
+    skipSuppression?: boolean;
+}
+export interface UpdateCandidate {
+    name: string;
+    currentVersion: string;
+    latestVersion: string;
+    /** semver-safe-update | update-possible */
+    updateType: string;
+    description?: string;
+    isSecurityUpdate: boolean;
+}
+export interface UpdateResult {
+    package: string;
+    oldVersion: string;
+    newVersion: string;
+    status: 'pass' | 'fail' | 'skip' | 'conflict';
+    branch: string;
+    commitHash?: string;
+    testSummary?: {
+        passed: number;
+        failed: number;
+        suppressed: number;
+    };
+    configChanges?: string[];
+    dbUpdates?: number;
+    error?: string;
+    duration: number;
+}
+export interface UpdateReport {
+    timestamp: string;
+    baseBranch: string;
+    totalCandidates: number;
+    updated: number;
+    failed: number;
+    skipped: number;
+    duration: number;
+    results: UpdateResult[];
+}
+export interface TestReport {
+    site: string;
+    timestamp: string;
+    duration: number;
+    mode: ExecutionMode;
+    summary: {
+        pluginsRan: number;
+        pluginsSkipped: number;
+        totalTests: number;
+        passed: number;
+        failed: number;
+        skipped: number;
+        warned: number;
+        suppressed: number;
+        worstSeverity: string | null;
+    };
+    results: TestResult[];
+    plugins: PluginSummary[];
+}
+export interface PluginSummary {
+    name: string;
+    status: 'ran' | 'skipped';
+    reason?: string;
+    tests: number;
+    passed: number;
+    failed: number;
+    skipped: number;
+    duration: number;
+}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Shared interfaces for the Bolt test runner.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/modules/bolt_inspect/bolt_inspect.info.yml

@@ -0,0 +1,6 @@
+name: 'Bolt Inspect'
+type: module
+description: 'Site introspection and test content management for Bolt CLI.'
+core_version_requirement: ^11
+package: Development
+version: '0.1.0'

package/modules/bolt_inspect/bolt_inspect.services.yml

@@ -0,0 +1,22 @@
+services:
+  bolt_inspect.site_profiler:
+    class: Drupal\bolt_inspect\Service\SiteProfiler
+    arguments:
+      - '@entity_type.manager'
+      - '@entity_field.manager'
+      - '@extension.list.module'
+      - '@router.route_provider'
+      - '@menu.link_tree'
+
+  bolt_inspect.content_generator:
+    class: Drupal\bolt_inspect\Service\ContentGenerator
+    arguments:
+      - '@entity_type.manager'
+      - '@entity_field.manager'
+      - '@bolt_inspect.entity_tracker'
+
+  bolt_inspect.entity_tracker:
+    class: Drupal\bolt_inspect\Service\TestEntityTracker
+    arguments:
+      - '@state'
+      - '@entity_type.manager'

package/modules/bolt_inspect/composer.json

@@ -0,0 +1,16 @@
+{
+  "name": "bolt/bolt_inspect",
+  "description": "Drupal site introspection and test content management for Bolt CLI",
+  "type": "drupal-module",
+  "license": "GPL-2.0-or-later",
+  "require": {
+    "drupal/core": "^11"
+  },
+  "extra": {
+    "drush": {
+      "services": {
+        "drush.services.yml": "^13"
+      }
+    }
+  }
+}

package/modules/bolt_inspect/drush.services.yml

@@ -0,0 +1,10 @@
+services:
+  bolt_inspect.commands:
+    class: Drupal\bolt_inspect\Drush\Commands\BoltInspectCommands
+    arguments:
+      - '@bolt_inspect.site_profiler'
+      - '@bolt_inspect.content_generator'
+      - '@bolt_inspect.entity_tracker'
+      - '@entity_type.manager'
+    tags:
+      - { name: drush.command }

package/modules/bolt_inspect/src/Drush/Commands/BoltInspectCommands.php

@@ -0,0 +1,203 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\bolt_inspect\Drush\Commands;
+
+use Drupal\bolt_inspect\Service\ContentGenerator;
+use Drupal\bolt_inspect\Service\SiteProfiler;
+use Drupal\bolt_inspect\Service\TestEntityTracker;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drush\Attributes as CLI;
+use Drush\Commands\DrushCommands;
+
+/**
+ * Drush commands for Bolt site inspection and test content management.
+ */
+class BoltInspectCommands extends DrushCommands {
+
+  public function __construct(
+    private readonly SiteProfiler $profiler,
+    private readonly ContentGenerator $generator,
+    private readonly TestEntityTracker $tracker,
+    private readonly EntityTypeManagerInterface $entityTypeManager,
+  ) {
+    parent::__construct();
+  }
+
+  /**
+   * Return full site structure as JSON.
+   */
+  #[CLI\Command(name: 'bolt-inspect:profile')]
+  #[CLI\Usage(name: 'drush bolt-inspect:profile', description: 'Output site profile as JSON')]
+  public function profile(): void {
+    $profile = $this->profiler->profile();
+    $this->output()->writeln(json_encode($profile, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
+  }
+
+  /**
+   * Generate test content — one node per content type with required fields.
+   */
+  #[CLI\Command(name: 'bolt-inspect:generate')]
+  #[CLI\Usage(name: 'drush bolt-inspect:generate', description: 'Create test content for all content types')]
+  public function generate(): void {
+    if ($this->tracker->hasTracked()) {
+      $this->logger()->notice('Test content already exists. Run bolt-inspect:cleanup first or use existing content.');
+      $this->listTracked();
+      return;
+    }
+
+    $this->logger()->notice('Generating test content...');
+    $results = $this->generator->generateAll();
+
+    $rows = [];
+    $errors = 0;
+    foreach ($results as $bundle => $result) {
+      if ($result['status'] === 'created') {
+        $rows[] = [$bundle, 'CREATED', $result['nid'], $result['label']];
+      }
+      else {
+        $rows[] = [$bundle, 'ERROR', '', $result['error'] ?? 'Unknown error'];
+        $errors++;
+      }
+    }
+
+    $this->io()->table(['Content Type', 'Status', 'NID', 'Detail'], $rows);
+
+    $total = count($results);
+    $created = $total - $errors;
+    $this->logger()->success("Generated {$created}/{$total} content types.");
+
+    if ($errors > 0) {
+      $this->logger()->warning("{$errors} content type(s) had errors.");
+    }
+  }
+
+  /**
+   * Remove all generated test content.
+   */
+  #[CLI\Command(name: 'bolt-inspect:cleanup')]
+  #[CLI\Usage(name: 'drush bolt-inspect:cleanup', description: 'Remove all bolt test content')]
+  public function cleanup(): void {
+    if (!$this->tracker->hasTracked()) {
+      $this->logger()->notice('No test content to clean up.');
+      return;
+    }
+
+    $tracked = $this->tracker->getTracked();
+    $count = count($tracked);
+    $this->logger()->notice("Cleaning up {$count} tracked entities...");
+
+    $counts = $this->tracker->cleanupAll();
+
+    $rows = [];
+    foreach ($counts as $type => $deleted) {
+      $rows[] = [$type, $deleted];
+    }
+    $this->io()->table(['Entity Type', 'Deleted'], $rows);
+
+    $total = array_sum($counts);
+    $this->logger()->success("Cleaned up {$total} entities.");
+  }
+
+  /**
+   * List all currently tracked test entities.
+   */
+  #[CLI\Command(name: 'bolt-inspect:list')]
+  #[CLI\Usage(name: 'drush bolt-inspect:list', description: 'List tracked test entities')]
+  public function listTracked(): void {
+    $tracked = $this->tracker->getTracked();
+
+    if (empty($tracked)) {
+      $this->logger()->notice('No tracked test entities.');
+      return;
+    }
+
+    $rows = [];
+    foreach ($tracked as $entry) {
+      $rows[] = [
+        $entry['entity_type'],
+        $entry['id'],
+        $entry['label'],
+        date('Y-m-d H:i:s', $entry['created']),
+      ];
+    }
+
+    $this->io()->table(['Entity Type', 'ID', 'Label', 'Created'], $rows);
+    $this->logger()->notice(count($tracked) . ' tracked entities.');
+  }
+
+  /**
+   * Render test nodes and report status per content type.
+   *
+   * Loads each unpublished test node, renders it in isolation, and returns
+   * a JSON array with status, nid, title, html_length, or error per bundle.
+   */
+  #[CLI\Command(name: 'bolt-inspect:render-check')]
+  #[CLI\Usage(name: 'drush bolt-inspect:render-check', description: 'Render-check all generated test nodes')]
+  public function renderCheck(): void {
+    $nodeStorage = $this->entityTypeManager->getStorage('node');
+    $viewBuilder = $this->entityTypeManager->getViewBuilder('node');
+    $renderer = \Drupal::service('renderer');
+
+    $nodeTypes = $this->entityTypeManager->getStorage('node_type')->loadMultiple();
+    $results = [];
+
+    foreach ($nodeTypes as $nodeType) {
+      $bundle = $nodeType->id();
+
+      // Find the test node for this bundle.
+      $nodes = $nodeStorage->loadByProperties([
+        'type' => $bundle,
+        'status' => 0,
+        'uid' => 1,
+      ]);
+
+      // Filter to bolt-generated nodes.
+      $node = NULL;
+      foreach ($nodes as $candidate) {
+        $title = $candidate->label() ?? '';
+        if (str_starts_with($title, 'Bolt Test:') || str_starts_with($title, 'Bolt test')) {
+          $node = $candidate;
+          break;
+        }
+      }
+
+      if (!$node) {
+        $results[] = [
+          'bundle' => $bundle,
+          'label' => $nodeType->label(),
+          'status' => 'missing',
+        ];
+        continue;
+      }
+
+      try {
+        $build = $viewBuilder->view($node, 'full');
+        $html = $renderer->renderInIsolation($build);
+        $len = strlen((string) $html);
+
+        $results[] = [
+          'bundle' => $bundle,
+          'label' => $nodeType->label(),
+          'status' => 'ok',
+          'nid' => (int) $node->id(),
+          'title' => $node->label(),
+          'html_length' => $len,
+        ];
+      }
+      catch (\Throwable $e) {
+        $results[] = [
+          'bundle' => $bundle,
+          'label' => $nodeType->label(),
+          'status' => 'error',
+          'nid' => (int) $node->id(),
+          'error' => $e->getMessage(),
+        ];
+      }
+    }
+
+    $this->output()->writeln(json_encode($results, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
+  }
+
+}