How to ignore file leaks with deno test

[abdurahmanshiine]

Hey guys,

I keep getting this error

error: Leaks detected:
  - A file was opened during the test, but not closed during the test. Close the file handle by calling `file.close()`.

The issue is it's not telling me which file it is, or which file object it's referring to, so I was wondering how can I disable leaks tracing in testing, I honestly don't even need that at this point.

Version: Deno 2.1.4

[kt3k]

You can disable resource leak detection by passing sanitizeResources: false option to Deno.test

https://docs.deno.com/runtime/fundamentals/testing/#resource-sanitizer

Deno.test("my test", { sanitizeResources: false }, async () => {
  const file = await Deno.open("README.md");
  // now it's fine to leave the file open
});

[abdurahmanshiine]

Hey @kt3k,
Thanks for your response. I'm using the @std/testing package so I can write the tests in jest style. Can I pass the same option to it?

[kt3k]

Yes, you can pass sanitizeResources: false to describe or it:

import { describe, it } from "jsr:@std/testing/bdd";

describe("foo", { sanitizeResources: false }, () => {
  it("bar", async () => {
    const file = await Deno.open("README.md");
  });
});

Alternatively, there's unstable API for disabling leak detection for the entire file:

import { describe, it } from "jsr:@std/testing/bdd";
import { configureGlobalSanitizers } from "jsr:@std/testing/unstable-bdd";

configureGlobalSanitizers({
  sanitizeResources: false,
});

describe("foo", () => {
  it("bar", async () => {
    const file = await Deno.open("README.md");
  });
});

This might look cleaner if there's many test cases in a single file.

FYI there's also a similar option sanitizeOps: false which disables the detection of async operation leaks such as setTimeout. You might be also interested in disabling this.