summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--cli/tests/unit/console_test.ts4
-rw-r--r--cli/tests/unit/form_data_test.ts8
-rw-r--r--cli/tests/unit/headers_test.ts8
-rw-r--r--cli/tests/unit/process_test.ts6
-rw-r--r--cli/tests/unit/test_util.ts2
-rw-r--r--docs/testing.md4
-rw-r--r--docs/testing/assertions.md18
-rw-r--r--std/examples/xeval_test.ts4
-rw-r--r--std/fs/empty_dir_test.ts4
-rw-r--r--std/fs/exists_test.ts4
-rw-r--r--std/fs/expand_glob_test.ts4
-rw-r--r--std/http/server_test.ts4
-rw-r--r--std/node/module_test.ts4
-rw-r--r--std/testing/README.md4
-rw-r--r--std/testing/asserts.ts16
-rw-r--r--std/testing/asserts_test.ts26
16 files changed, 60 insertions, 60 deletions
diff --git a/cli/tests/unit/console_test.ts b/cli/tests/unit/console_test.ts
index 11cefda27..268432822 100644
--- a/cli/tests/unit/console_test.ts
+++ b/cli/tests/unit/console_test.ts
@@ -11,7 +11,7 @@
import {
assert,
assertEquals,
- assertStringContains,
+ assertStringIncludes,
unitTest,
} from "./test_util.ts";
import { stripColor } from "../../../std/fmt/colors.ts";
@@ -1703,5 +1703,5 @@ unitTest(function inspectProxy(): void {
unitTest(function inspectColors(): void {
assertEquals(Deno.inspect(1), "1");
- assertStringContains(Deno.inspect(1, { colors: true }), "\x1b[");
+ assertStringIncludes(Deno.inspect(1, { colors: true }), "\x1b[");
});
diff --git a/cli/tests/unit/form_data_test.ts b/cli/tests/unit/form_data_test.ts
index b4b998a50..fc59c1a0d 100644
--- a/cli/tests/unit/form_data_test.ts
+++ b/cli/tests/unit/form_data_test.ts
@@ -2,7 +2,7 @@
import {
assert,
assertEquals,
- assertStringContains,
+ assertStringIncludes,
unitTest,
} from "./test_util.ts";
@@ -155,7 +155,7 @@ unitTest(function formDataParamsArgumentsCheck(): void {
}
}
assertEquals(hasThrown, 2);
- assertStringContains(
+ assertStringIncludes(
errMsg,
`${method} requires at least 1 argument, but only 0 present`,
);
@@ -179,7 +179,7 @@ unitTest(function formDataParamsArgumentsCheck(): void {
}
}
assertEquals(hasThrown, 2);
- assertStringContains(
+ assertStringIncludes(
errMsg,
`${method} requires at least 2 arguments, but only 0 present`,
);
@@ -199,7 +199,7 @@ unitTest(function formDataParamsArgumentsCheck(): void {
}
}
assertEquals(hasThrown, 2);
- assertStringContains(
+ assertStringIncludes(
errMsg,
`${method} requires at least 2 arguments, but only 1 present`,
);
diff --git a/cli/tests/unit/headers_test.ts b/cli/tests/unit/headers_test.ts
index 7ed7e1e2e..fba6f19c4 100644
--- a/cli/tests/unit/headers_test.ts
+++ b/cli/tests/unit/headers_test.ts
@@ -2,7 +2,7 @@
import {
assert,
assertEquals,
- assertStringContains,
+ assertStringIncludes,
unitTest,
} from "./test_util.ts";
const {
@@ -285,7 +285,7 @@ unitTest(function headerParamsArgumentsCheck(): void {
}
}
assertEquals(hasThrown, 2);
- assertStringContains(
+ assertStringIncludes(
errMsg,
`${method} requires at least 1 argument, but only 0 present`,
);
@@ -309,7 +309,7 @@ unitTest(function headerParamsArgumentsCheck(): void {
}
}
assertEquals(hasThrown, 2);
- assertStringContains(
+ assertStringIncludes(
errMsg,
`${method} requires at least 2 arguments, but only 0 present`,
);
@@ -329,7 +329,7 @@ unitTest(function headerParamsArgumentsCheck(): void {
}
}
assertEquals(hasThrown, 2);
- assertStringContains(
+ assertStringIncludes(
errMsg,
`${method} requires at least 2 arguments, but only 1 present`,
);
diff --git a/cli/tests/unit/process_test.ts b/cli/tests/unit/process_test.ts
index ef3f5023e..43d848916 100644
--- a/cli/tests/unit/process_test.ts
+++ b/cli/tests/unit/process_test.ts
@@ -2,7 +2,7 @@
import {
assert,
assertEquals,
- assertStringContains,
+ assertStringIncludes,
assertThrows,
unitTest,
} from "./test_util.ts";
@@ -310,8 +310,8 @@ unitTest(
const decoder = new TextDecoder();
const text = decoder.decode(fileContents);
- assertStringContains(text, "error");
- assertStringContains(text, "output");
+ assertStringIncludes(text, "error");
+ assertStringIncludes(text, "output");
},
);
diff --git a/cli/tests/unit/test_util.ts b/cli/tests/unit/test_util.ts
index 746eb2c17..5212ba0f8 100644
--- a/cli/tests/unit/test_util.ts
+++ b/cli/tests/unit/test_util.ts
@@ -10,7 +10,7 @@ export {
assertMatch,
assertNotEquals,
assertStrictEquals,
- assertStringContains,
+ assertStringIncludes,
assertThrows,
assertThrowsAsync,
fail,
diff --git a/docs/testing.md b/docs/testing.md
index 7ea9ff18c..b075bbca3 100644
--- a/docs/testing.md
+++ b/docs/testing.md
@@ -32,14 +32,14 @@ https://deno.land/std@$STD_VERSION/testing#usage to make testing easier:
```ts
import {
- assertArrayContains,
+ assertArrayIncludes,
assertEquals,
} from "https://deno.land/std@$STD_VERSION/testing/asserts.ts";
Deno.test("hello world", () => {
const x = 1 + 2;
assertEquals(x, 3);
- assertArrayContains([1, 2, 3, 4, 5, 6], [3], "Expected 3 to be in the array");
+ assertArrayIncludes([1, 2, 3, 4, 5, 6], [3], "Expected 3 to be in the array");
});
```
diff --git a/docs/testing/assertions.md b/docs/testing/assertions.md
index fe37eedd6..e80e760fe 100644
--- a/docs/testing/assertions.md
+++ b/docs/testing/assertions.md
@@ -18,8 +18,8 @@ The assertions module provides 10 assertions:
- `assertEquals(actual: unknown, expected: unknown, msg?: string): void`
- `assertNotEquals(actual: unknown, expected: unknown, msg?: string): void`
- `assertStrictEquals(actual: unknown, expected: unknown, msg?: string): void`
-- `assertStringContains(actual: string, expected: string, msg?: string): void`
-- `assertArrayContains(actual: unknown[], expected: unknown[], msg?: string): void`
+- `assertStringIncludes(actual: string, expected: string, msg?: string): void`
+- `assertArrayIncludes(actual: unknown[], expected: unknown[], msg?: string): void`
- `assertMatch(actual: string, expected: RegExp, msg?: string): void`
- `assertNotMatch(actual: string, expected: RegExp, msg?: string): void`
- `assertThrows(fn: () => void, ErrorClass?: Constructor, msgIncludes = "", msg?: string): Error`
@@ -92,25 +92,25 @@ precise check against two primitive types.
### Contains
There are two methods available to assert a value contains a value,
-`assertStringContains()` and `assertArrayContains()`.
+`assertStringIncludes()` and `assertArrayIncludes()`.
-The `assertStringContains()` assertion does a simple includes check on a string
+The `assertStringIncludes()` assertion does a simple includes check on a string
to see if it contains the expected string.
```js
Deno.test("Test Assert String Contains", () => {
- assertStringContains("Hello World", "Hello");
+ assertStringIncludes("Hello World", "Hello");
});
```
-The `assertArrayContains()` assertion is slightly more advanced and can find
+The `assertArrayIncludes()` assertion is slightly more advanced and can find
both a value within an array and an array of values within an array.
```js
Deno.test("Test Assert Array Contains", () => {
- assertArrayContains([1, 2, 3], [1]);
- assertArrayContains([1, 2, 3], [1, 2]);
- assertArrayContains(Array.from("Hello World"), Array.from("Hello"));
+ assertArrayIncludes([1, 2, 3], [1]);
+ assertArrayIncludes([1, 2, 3], [1, 2]);
+ assertArrayIncludes(Array.from("Hello World"), Array.from("Hello"));
});
```
diff --git a/std/examples/xeval_test.ts b/std/examples/xeval_test.ts
index 972d71ae4..6d24d08bb 100644
--- a/std/examples/xeval_test.ts
+++ b/std/examples/xeval_test.ts
@@ -5,7 +5,7 @@ import { decode, encode } from "../encoding/utf8.ts";
import {
assert,
assertEquals,
- assertStringContains,
+ assertStringIncludes,
} from "../testing/asserts.ts";
import { dirname, fromFileUrl } from "../path/mod.ts";
@@ -66,6 +66,6 @@ Deno.test("xevalCliSyntaxError", async function (): Promise<void> {
});
assertEquals(await p.status(), { code: 1, success: false });
assertEquals(decode(await p.output()), "");
- assertStringContains(decode(await p.stderrOutput()), "SyntaxError");
+ assertStringIncludes(decode(await p.stderrOutput()), "SyntaxError");
p.close();
});
diff --git a/std/fs/empty_dir_test.ts b/std/fs/empty_dir_test.ts
index 851fe37b9..6c3406115 100644
--- a/std/fs/empty_dir_test.ts
+++ b/std/fs/empty_dir_test.ts
@@ -2,7 +2,7 @@
import {
assert,
assertEquals,
- assertStringContains,
+ assertStringIncludes,
assertThrows,
assertThrowsAsync,
} from "../testing/asserts.ts";
@@ -231,7 +231,7 @@ for (const s of scenes) {
assert(p.stdout);
const output = await p.output();
p.close();
- assertStringContains(new TextDecoder().decode(output), s.output);
+ assertStringIncludes(new TextDecoder().decode(output), s.output);
} catch (err) {
await Deno.remove(testfolder, { recursive: true });
throw err;
diff --git a/std/fs/exists_test.ts b/std/fs/exists_test.ts
index f4088e03a..6619cce10 100644
--- a/std/fs/exists_test.ts
+++ b/std/fs/exists_test.ts
@@ -1,5 +1,5 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
-import { assertEquals, assertStringContains } from "../testing/asserts.ts";
+import { assertEquals, assertStringIncludes } from "../testing/asserts.ts";
import * as path from "../path/mod.ts";
import { exists, existsSync } from "./exists.ts";
@@ -130,7 +130,7 @@ for (const s of scenes) {
const output = await p.output();
p.close();
- assertStringContains(new TextDecoder().decode(output), s.output);
+ assertStringIncludes(new TextDecoder().decode(output), s.output);
});
// done
}
diff --git a/std/fs/expand_glob_test.ts b/std/fs/expand_glob_test.ts
index 39235906b..768c6465a 100644
--- a/std/fs/expand_glob_test.ts
+++ b/std/fs/expand_glob_test.ts
@@ -3,7 +3,7 @@ import { decode } from "../encoding/utf8.ts";
import {
assert,
assertEquals,
- assertStringContains,
+ assertStringIncludes,
} from "../testing/asserts.ts";
import {
fromFileUrl,
@@ -126,7 +126,7 @@ Deno.test("expandGlobPermError", async function (): Promise<void> {
});
assertEquals(await p.status(), { code: 1, success: false });
assertEquals(decode(await p.output()), "");
- assertStringContains(
+ assertStringIncludes(
decode(await p.stderrOutput()),
"Uncaught PermissionDenied",
);
diff --git a/std/http/server_test.ts b/std/http/server_test.ts
index 76b0bcff9..f26dc63cd 100644
--- a/std/http/server_test.ts
+++ b/std/http/server_test.ts
@@ -10,7 +10,7 @@ import {
assert,
assertEquals,
assertMatch,
- assertStringContains,
+ assertStringIncludes,
assertThrowsAsync,
} from "../testing/asserts.ts";
import {
@@ -498,7 +498,7 @@ Deno.test({
const nread = await conn.read(res);
assert(nread !== null);
const resStr = new TextDecoder().decode(res.subarray(0, nread));
- assertStringContains(resStr, "/hello");
+ assertStringIncludes(resStr, "/hello");
server.close();
await p;
// Client connection should still be open, verify that
diff --git a/std/node/module_test.ts b/std/node/module_test.ts
index 2b8c5c790..2b3ed3eed 100644
--- a/std/node/module_test.ts
+++ b/std/node/module_test.ts
@@ -3,7 +3,7 @@
import {
assert,
assertEquals,
- assertStringContains,
+ assertStringIncludes,
} from "../testing/asserts.ts";
import * as path from "../path/mod.ts";
@@ -67,6 +67,6 @@ Deno.test("requireStack", function () {
try {
hello();
} catch (e) {
- assertStringContains(e.stack, "/tests/cjs/cjs_throw.js");
+ assertStringIncludes(e.stack, "/tests/cjs/cjs_throw.js");
}
});
diff --git a/std/testing/README.md b/std/testing/README.md
index f970471cb..2cff96a6d 100644
--- a/std/testing/README.md
+++ b/std/testing/README.md
@@ -18,12 +18,12 @@ pretty-printed diff of failing assertion.
and `expected` are equal.
- `assertStrictEquals()` - Compares `actual` and `expected` strictly, therefore
for non-primitives the values must reference the same instance.
-- `assertStringContains()` - Make an assertion that `actual` contains
+- `assertStringIncludes()` - Make an assertion that `actual` includes
`expected`.
- `assertMatch()` - Make an assertion that `actual` match RegExp `expected`.
- `assertNotMatch()` - Make an assertion that `actual` not match RegExp
`expected`.
-- `assertArrayContains()` - Make an assertion that `actual` array contains the
+- `assertArrayIncludes()` - Make an assertion that `actual` array includes the
`expected` values.
- `assertObjectMatch()` - Make an assertion that `actual` object match
`expected` subset object
diff --git a/std/testing/asserts.ts b/std/testing/asserts.ts
index 1d58f0a00..d46b26ded 100644
--- a/std/testing/asserts.ts
+++ b/std/testing/asserts.ts
@@ -330,10 +330,10 @@ export function assertNotStrictEquals(
}
/**
- * Make an assertion that actual contains expected. If not
+ * Make an assertion that actual includes expected. If not
* then thrown.
*/
-export function assertStringContains(
+export function assertStringIncludes(
actual: string,
expected: string,
msg?: string,
@@ -347,26 +347,26 @@ export function assertStringContains(
}
/**
- * Make an assertion that `actual` contains the `expected` values.
+ * Make an assertion that `actual` includes the `expected` values.
* If not then an error will be thrown.
*
* Type parameter can be specified to ensure values under comparison have the same type.
* For example:
*```ts
- *assertArrayContains<number>([1, 2], [2])
+ *assertArrayIncludes<number>([1, 2], [2])
*```
*/
-export function assertArrayContains(
+export function assertArrayIncludes(
actual: ArrayLike<unknown>,
expected: ArrayLike<unknown>,
msg?: string,
): void;
-export function assertArrayContains<T>(
+export function assertArrayIncludes<T>(
actual: ArrayLike<T>,
expected: ArrayLike<T>,
msg?: string,
): void;
-export function assertArrayContains(
+export function assertArrayIncludes(
actual: ArrayLike<unknown>,
expected: ArrayLike<unknown>,
msg?: string,
@@ -388,7 +388,7 @@ export function assertArrayContains(
return;
}
if (!msg) {
- msg = `actual: "${_format(actual)}" expected to contain: "${
+ msg = `actual: "${_format(actual)}" expected to include: "${
_format(expected)
}"\nmissing: ${_format(missing)}`;
}
diff --git a/std/testing/asserts_test.ts b/std/testing/asserts_test.ts
index a0db48e7b..d357a761b 100644
--- a/std/testing/asserts_test.ts
+++ b/std/testing/asserts_test.ts
@@ -2,7 +2,7 @@
import {
_format,
assert,
- assertArrayContains,
+ assertArrayIncludes,
assertEquals,
AssertionError,
assertMatch,
@@ -11,7 +11,7 @@ import {
assertNotStrictEquals,
assertObjectMatch,
assertStrictEquals,
- assertStringContains,
+ assertStringIncludes,
assertThrows,
assertThrowsAsync,
equal,
@@ -161,12 +161,12 @@ Deno.test("testingNotEquals", function (): void {
});
Deno.test("testingAssertStringContains", function (): void {
- assertStringContains("Denosaurus", "saur");
- assertStringContains("Denosaurus", "Deno");
- assertStringContains("Denosaurus", "rus");
+ assertStringIncludes("Denosaurus", "saur");
+ assertStringIncludes("Denosaurus", "Deno");
+ assertStringIncludes("Denosaurus", "rus");
let didThrow;
try {
- assertStringContains("Denosaurus", "Raptor");
+ assertStringIncludes("Denosaurus", "Raptor");
didThrow = false;
} catch (e) {
assert(e instanceof AssertionError);
@@ -178,14 +178,14 @@ Deno.test("testingAssertStringContains", function (): void {
Deno.test("testingArrayContains", function (): void {
const fixture = ["deno", "iz", "luv"];
const fixtureObject = [{ deno: "luv" }, { deno: "Js" }];
- assertArrayContains(fixture, ["deno"]);
- assertArrayContains(fixtureObject, [{ deno: "luv" }]);
- assertArrayContains(
+ assertArrayIncludes(fixture, ["deno"]);
+ assertArrayIncludes(fixtureObject, [{ deno: "luv" }]);
+ assertArrayIncludes(
Uint8Array.from([1, 2, 3, 4]),
Uint8Array.from([1, 2, 3]),
);
assertThrows(
- (): void => assertArrayContains(fixtureObject, [{ deno: "node" }]),
+ (): void => assertArrayIncludes(fixtureObject, [{ deno: "node" }]),
AssertionError,
`actual: "[
{
@@ -194,7 +194,7 @@ Deno.test("testingArrayContains", function (): void {
{
deno: "Js",
},
-]" expected to contain: "[
+]" expected to include: "[
{
deno: "node",
},
@@ -210,7 +210,7 @@ missing: [
Deno.test("testingAssertStringContainsThrow", function (): void {
let didThrow = false;
try {
- assertStringContains("Denosaurus from Jurassic", "Raptor");
+ assertStringIncludes("Denosaurus from Jurassic", "Raptor");
} catch (e) {
assert(
e.message ===
@@ -715,7 +715,7 @@ Deno.test({
fn(): void {
assertEquals<string>("hello", "hello");
assertNotEquals<number>(1, 2);
- assertArrayContains<boolean>([true, false], [true]);
+ assertArrayIncludes<boolean>([true, false], [true]);
const value = { x: 1 };
assertStrictEquals<typeof value>(value, value);
// eslint-disable-next-line @typescript-eslint/ban-types
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-27 17:05:11 +0000