Files
AgentCompany/builtin-skills/software-engineer/clean-code/references/test-build-operate-check.md
T
ZacharyZhang-NY e74dafcd36 Silence render-disposed spam, unbreak bundled skills, drop board wake
Three independently ugly bugs that all fed the same log flood:

* Electron's `WebFrameMain.send` writes every "Render frame was disposed"
  to stderr via `console.error`. When the worker fans a second
  agent-event past a reloading renderer, we produced thousands of
  identical lines and stalled the main loop on stderr I/O. Added a
  `mainFrame.detached` guard so the send is short-circuited before
  Electron's own catch block fires, and installed a targeted filter in
  `suppress-warnings.ts` (now actually imported from the entry point)
  so the specific `console.error("Error sending from webFrameMain:"…)`
  noise never reaches the terminal. Any other payload still surfaces.

* `dispatchAgentMessage` accepted the human-reader sentinel as a wake
  target when an agent replied to `__board__` — `wakeAgentIfPossible`
  then called `db.getAgent("__board__")`, threw, and the dispatcher
  kept repeating on every send. Strip `HUMAN_SENDER_ID` at
  `resolveMessageWakeTargets`, and keep a defense-in-depth guard in the
  heartbeat so a stray caller (future automation fan-out) cannot
  reintroduce the crash.

* Pi's skills loader rejects any SKILL.md whose frontmatter `name`
  diverges from its parent directory. The four bundled `my-writing-style`
  copies declared `name: writing-style-skill`, so every install emitted
  a warning and dropped the skill. They also lived as orphan gitlinks
  (mode 160000 without .gitmodules), and the global `*.md` gitignore
  hid every other SKILL.md from version control. Fixed the frontmatter
  to match the dir, converted the dangling submodules to plain trees,
  and allowlisted `builtin-skills/**/*.md` so a fresh clone carries the
  catalogue instead of silently losing it.
2026-04-20 08:13:48 -04:00

1.8 KiB

title, impact, impactDescription, tags
title impact impactDescription tags
Use Build-Operate-Check Pattern MEDIUM reduces test comprehension time by 50% test, boc, arrange-act-assert, structure

Use Build-Operate-Check Pattern

Structure tests in three distinct phases: Build (arrange), Operate (act), Check (assert). This pattern makes tests easy to read and understand at a glance.

Incorrect (mixed phases, unclear structure):

@Test
public void testOrder() {
    Order order = new Order();
    assertTrue(order.isEmpty());
    Product product = new Product("Widget", 9.99);
    order.add(product);
    assertEquals(1, order.getItemCount());
    assertEquals(9.99, order.getTotal(), 0.01);
    order.add(product);
    assertEquals(2, order.getItemCount());
    assertEquals(19.98, order.getTotal(), 0.01);
}

Correct (clear Build-Operate-Check):

@Test
public void addingProductShouldIncreaseItemCount() {
    // Build
    Order order = new Order();
    Product widget = new Product("Widget", 9.99);

    // Operate
    order.add(widget);

    // Check
    assertEquals(1, order.getItemCount());
}

@Test
public void addingProductShouldUpdateTotal() {
    // Build
    Order order = new Order();
    Product widget = new Product("Widget", 9.99);

    // Operate
    order.add(widget);

    // Check
    assertEquals(9.99, order.getTotal(), 0.01);
}

@Test
public void addingSameProductTwiceShouldDoubleTotal() {
    // Build
    Order order = new Order();
    Product widget = new Product("Widget", 9.99);

    // Operate
    order.add(widget);
    order.add(widget);

    // Check
    assertEquals(19.98, order.getTotal(), 0.01);
}

Alias patterns:

  • Build-Operate-Check (BOC)
  • Arrange-Act-Assert (AAA)
  • Given-When-Then (BDD)

Reference: Clean Code, Chapter 9: Unit Tests