Files
AgentCompany/builtin-skills/software-engineer/clean-code/references/test-keep-clean.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.7 KiB

title, impact, impactDescription, tags
title impact impactDescription tags
Keep Tests Clean MEDIUM maintains test maintainability over time test, clean, maintainability, quality

Keep Tests Clean

Test code is just as important as production code. It requires thought, design, and care. If you let tests rot, they become a liability instead of an asset.

Incorrect (dirty tests):

@Test
public void test1() {
    // Cryptic, no clear purpose
    S s = new S();
    s.a("x");
    s.b("y");
    assertTrue(s.c());
    s.d();
    assertEquals("xy", s.e());
}

@Test
public void testEverything() {
    // Multiple assertions testing different concepts
    assertNotNull(user);
    assertEquals("Bob", user.getName());
    assertTrue(user.isActive());
    assertEquals(3, user.getOrders().size());
    assertTrue(user.getOrders().get(0).isPaid());
}

Correct (clean, readable tests):

@Test
public void concatenatingTwoStringsShouldReturnCombinedResult() {
    StringBuffer buffer = new StringBuffer();

    buffer.append("first");
    buffer.append("second");

    assertEquals("firstsecond", buffer.toString());
}

@Test
public void userShouldBeActiveAfterActivation() {
    User user = new User("Bob");

    user.activate();

    assertTrue(user.isActive());
}

@Test
public void activatingUserShouldSendWelcomeEmail() {
    User user = new User("Bob");
    EmailService emailService = mock(EmailService.class);

    user.activate(emailService);

    verify(emailService).sendWelcome(user.getEmail());
}

Qualities of clean tests:

  • Readable: Clear setup, action, assertion
  • One concept per test
  • Descriptive names explaining what is being tested

Reference: Clean Code, Chapter 9: Unit Tests