@zukhruf/testing 0.8.18 → 0.8.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -37
- package/dist/databases/collector.d.ts +23 -20
- package/dist/databases/collector.d.ts.map +1 -1
- package/dist/databases/collector.js +9 -6
- package/dist/databases/collector.js.map +1 -1
- package/dist/databases/mysql-family-collector.d.ts +1 -6
- package/dist/databases/mysql-family-collector.d.ts.map +1 -1
- package/dist/databases/mysql-family-collector.js +12 -20
- package/dist/databases/mysql-family-collector.js.map +1 -1
- package/dist/databases/mysql-family-server.d.ts.map +1 -1
- package/dist/databases/mysql-family-server.js +2 -6
- package/dist/databases/mysql-family-server.js.map +1 -1
- package/dist/databases/postgres-collector.d.ts +1 -6
- package/dist/databases/postgres-collector.d.ts.map +1 -1
- package/dist/databases/postgres-collector.js +13 -20
- package/dist/databases/postgres-collector.js.map +1 -1
- package/dist/databases/postgres.d.ts.map +1 -1
- package/dist/databases/postgres.js +2 -3
- package/dist/databases/postgres.js.map +1 -1
- package/dist/databases/sqlserver-collector.d.ts +2 -5
- package/dist/databases/sqlserver-collector.d.ts.map +1 -1
- package/dist/databases/sqlserver-collector.js +20 -37
- package/dist/databases/sqlserver-collector.js.map +1 -1
- package/dist/databases/sqlserver.d.ts +5 -2
- package/dist/databases/sqlserver.d.ts.map +1 -1
- package/dist/databases/sqlserver.js +11 -18
- package/dist/databases/sqlserver.js.map +1 -1
- package/dist/docker/reaper.d.ts +96 -0
- package/dist/docker/reaper.d.ts.map +1 -0
- package/dist/docker/reaper.js +557 -0
- package/dist/docker/reaper.js.map +1 -0
- package/dist/docker/run-records.d.ts +3 -10
- package/dist/docker/run-records.d.ts.map +1 -1
- package/dist/docker/run-records.js +3 -14
- package/dist/docker/run-records.js.map +1 -1
- package/dist/docker/testbed.d.ts +6 -7
- package/dist/docker/testbed.d.ts.map +1 -1
- package/dist/docker/testbed.js +52 -20
- package/dist/docker/testbed.js.map +1 -1
- package/dist/scripts/docker-global-setup.d.ts +6 -1
- package/dist/scripts/docker-global-setup.d.ts.map +1 -1
- package/dist/scripts/docker-global-setup.js +42 -97
- package/dist/scripts/docker-global-setup.js.map +1 -1
- package/dist/scripts/run-cleanup.d.ts +5 -13
- package/dist/scripts/run-cleanup.d.ts.map +1 -1
- package/dist/scripts/run-cleanup.js +24 -259
- package/dist/scripts/run-cleanup.js.map +1 -1
- package/package.json +3 -3
- package/dist/scripts/docker-cleanup-worker.d.ts +0 -21
- package/dist/scripts/docker-cleanup-worker.d.ts.map +0 -1
- package/dist/scripts/docker-cleanup-worker.js +0 -31
- package/dist/scripts/docker-cleanup-worker.js.map +0 -1
|
@@ -1,42 +1,25 @@
|
|
|
1
|
-
import sql from 'mssql';
|
|
2
1
|
export const connectionString = ({ host, port, password }, database) => `Server=${host},${port};Database=${database};User Id=sa;Password=${password};TrustServerCertificate=true;Encrypt=false;`;
|
|
3
|
-
|
|
4
|
-
const pool = new sql.ConnectionPool(connectionString(server, 'master'));
|
|
5
|
-
try {
|
|
6
|
-
await pool.connect();
|
|
7
|
-
return (await pool.request().query(text)).recordset;
|
|
8
|
-
}
|
|
9
|
-
finally {
|
|
10
|
-
await pool.close().catch(() => { });
|
|
11
|
-
}
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Speaks to the server with the `mssql` driver: the `azure-sql-edge` image
|
|
15
|
-
* has no `sqlcmd` to exec.
|
|
16
|
-
*/
|
|
2
|
+
/** Runs `sqlcmd` of the `mssql/server` image in the server's container (ADR 0020, item 8). */
|
|
17
3
|
export const sqlserver = {
|
|
18
4
|
kind: 'sqlserver',
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
}
|
|
38
|
-
async drop(server, name) {
|
|
39
|
-
await query(server, `IF DB_ID('${name}') IS NOT NULL BEGIN ALTER DATABASE [${name}] SET SINGLE_USER WITH ROLLBACK IMMEDIATE; DROP DATABASE [${name}]; END`);
|
|
40
|
-
},
|
|
5
|
+
credential: { variable: 'MSSQL_SA_PASSWORD' },
|
|
6
|
+
command: (password, sql) => [
|
|
7
|
+
'/opt/mssql-tools18/bin/sqlcmd',
|
|
8
|
+
'-C',
|
|
9
|
+
'-S',
|
|
10
|
+
'localhost',
|
|
11
|
+
'-U',
|
|
12
|
+
'sa',
|
|
13
|
+
'-P',
|
|
14
|
+
password,
|
|
15
|
+
'-b',
|
|
16
|
+
'-h',
|
|
17
|
+
'-1',
|
|
18
|
+
'-W',
|
|
19
|
+
'-Q',
|
|
20
|
+
`SET NOCOUNT ON; ${sql}`,
|
|
21
|
+
],
|
|
22
|
+
list: "SELECT name FROM sys.databases WHERE name LIKE 'test%'",
|
|
23
|
+
drop: (name) => `IF DB_ID('${name}') IS NOT NULL BEGIN ALTER DATABASE [${name}] SET SINGLE_USER WITH ROLLBACK IMMEDIATE; DROP DATABASE [${name}]; END`,
|
|
41
24
|
};
|
|
42
25
|
//# sourceMappingURL=sqlserver-collector.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sqlserver-collector.js","sourceRoot":"","sources":["../../src/databases/sqlserver-collector.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"sqlserver-collector.js","sourceRoot":"","sources":["../../src/databases/sqlserver-collector.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAmB,EACzC,QAAgB,EACR,EAAE,CACV,UAAU,IAAI,IAAI,IAAI,aAAa,QAAQ,wBAAwB,QAAQ,6CAA6C,CAAC;AAE3H,8FAA8F;AAC9F,MAAM,CAAC,MAAM,SAAS,GAAc;IAClC,IAAI,EAAE,WAAW;IACjB,UAAU,EAAE,EAAE,QAAQ,EAAE,mBAAmB,EAAE;IAC7C,OAAO,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,CAAC;QAC1B,+BAA+B;QAC/B,IAAI;QACJ,IAAI;QACJ,WAAW;QACX,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,QAAQ;QACR,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,IAAI;QACJ,mBAAmB,GAAG,EAAE;KACzB;IACD,IAAI,EAAE,wDAAwD;IAC9D,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CACb,aAAa,IAAI,wCAAwC,IAAI,6DAA6D,IAAI,QAAQ;CACzI,CAAC"}
|
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
import type { Database, DatabaseOptions } from './database.ts';
|
|
2
2
|
export type { Database, DatabaseOptions } from './database.ts';
|
|
3
3
|
export declare const SQL_SERVER_FULL_IMAGE = "mcr.microsoft.com/mssql/server:2022-latest";
|
|
4
|
-
|
|
5
|
-
|
|
4
|
+
/**
|
|
5
|
+
* SQL Server test configuration. The full image is the default on every
|
|
6
|
+
* engine, emulated on arm64: Microsoft builds it only for amd64, and it holds
|
|
7
|
+
* the `sqlcmd` that an exec needs.
|
|
8
|
+
*/
|
|
6
9
|
export declare class SqlServer {
|
|
7
10
|
#private;
|
|
8
11
|
constructor({ environment, image, password, database, labels, }: DatabaseOptions);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sqlserver.d.ts","sourceRoot":"","sources":["../../src/databases/sqlserver.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"sqlserver.d.ts","sourceRoot":"","sources":["../../src/databases/sqlserver.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAO/D,YAAY,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAE/D,eAAO,MAAM,qBAAqB,+CACY,CAAC;AAE/C;;;;GAIG;AACH,qBAAa,SAAS;;gBAKR,EACV,WAAW,EACX,KAA6B,EAC7B,QAA+B,EAC/B,QAAmB,EACnB,MAAM,GACP,EAAE,eAAe;IAMlB,mEAAmE;IAC7D,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC;IA0BnC,wEAAwE;IAClE,KAAK,IAAI,OAAO,CAAC,QAAQ,CAAC;CAmGjC"}
|
|
@@ -1,40 +1,34 @@
|
|
|
1
1
|
import sql from 'mssql';
|
|
2
|
-
import pMemoize from 'p-memoize';
|
|
3
2
|
import { timebox } from "../async/timebox.js";
|
|
4
3
|
import { readRun } from "../docker/run-records.js";
|
|
5
4
|
import { DockerTestbed } from "../docker/testbed.js";
|
|
6
|
-
import { KIND_LABEL, databaseName } from "./collector.js";
|
|
5
|
+
import { KIND_LABEL, databaseName, dropDatabase } from "./collector.js";
|
|
7
6
|
import { connectionString, sqlserver, } from "./sqlserver-collector.js";
|
|
8
7
|
export const SQL_SERVER_FULL_IMAGE = 'mcr.microsoft.com/mssql/server:2022-latest';
|
|
9
|
-
|
|
10
|
-
|
|
8
|
+
/**
|
|
9
|
+
* SQL Server test configuration. The full image is the default on every
|
|
10
|
+
* engine, emulated on arm64: Microsoft builds it only for amd64, and it holds
|
|
11
|
+
* the `sqlcmd` that an exec needs.
|
|
12
|
+
*/
|
|
11
13
|
export class SqlServer {
|
|
12
14
|
#docker;
|
|
13
15
|
#runId;
|
|
14
16
|
#options;
|
|
15
|
-
|
|
16
|
-
if (this.#options.image)
|
|
17
|
-
return this.#options.image;
|
|
18
|
-
const { Architecture } = await (await this.#docker.client()).info();
|
|
19
|
-
return ['arm64', 'aarch64'].includes(Architecture ?? '')
|
|
20
|
-
? SQL_SERVER_EDGE_IMAGE
|
|
21
|
-
: SQL_SERVER_FULL_IMAGE;
|
|
22
|
-
});
|
|
23
|
-
constructor({ environment, image, password = 'StrongP@ssw0rd123!', database = 'testdb', labels, }) {
|
|
17
|
+
constructor({ environment, image = SQL_SERVER_FULL_IMAGE, password = 'StrongP@ssw0rd123!', database = 'testdb', labels, }) {
|
|
24
18
|
this.#docker = new DockerTestbed({ environment });
|
|
25
19
|
this.#runId = readRun(environment)?.id;
|
|
26
20
|
this.#options = { image, password, database, labels };
|
|
27
21
|
}
|
|
28
22
|
/** Create an isolated database on the persistent shared server. */
|
|
29
23
|
async database() {
|
|
30
|
-
const image =
|
|
24
|
+
const { image } = this.#options;
|
|
31
25
|
const container = await this.#acquire(image, 'reuse');
|
|
32
26
|
const database = databaseName(this.#runId);
|
|
33
27
|
try {
|
|
34
28
|
await this.#createDatabase(container, database);
|
|
35
29
|
return this.#handle(container, image, database, async () => {
|
|
36
30
|
try {
|
|
37
|
-
await sqlserver.
|
|
31
|
+
await dropDatabase(sqlserver, container.container, this.#options.password, database);
|
|
38
32
|
}
|
|
39
33
|
catch {
|
|
40
34
|
// Best-effort: the run's cleanup drops a database that disposal left.
|
|
@@ -51,9 +45,8 @@ export class SqlServer {
|
|
|
51
45
|
}
|
|
52
46
|
/** Start a dedicated server; the returned handle owns its container. */
|
|
53
47
|
async start() {
|
|
54
|
-
const image =
|
|
48
|
+
const { image, database } = this.#options;
|
|
55
49
|
const container = await this.#acquire(image, 'serve');
|
|
56
|
-
const { database } = this.#options;
|
|
57
50
|
try {
|
|
58
51
|
await this.#createDatabase(container, database);
|
|
59
52
|
return this.#handle(container, image, database, () => container.cleanup());
|
|
@@ -100,7 +93,7 @@ export class SqlServer {
|
|
|
100
93
|
'ACCEPT_EULA=Y',
|
|
101
94
|
`MSSQL_SA_PASSWORD=${password}`,
|
|
102
95
|
'MSSQL_MEMORY_LIMIT_MB=2048',
|
|
103
|
-
|
|
96
|
+
'MSSQL_PID=Express',
|
|
104
97
|
],
|
|
105
98
|
HostConfig: {
|
|
106
99
|
Tmpfs: { '/var/opt/mssql': 'rw,size=2g,mode=1777' },
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sqlserver.js","sourceRoot":"","sources":["../../src/databases/sqlserver.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"sqlserver.js","sourceRoot":"","sources":["../../src/databases/sqlserver.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAExE,OAAO,EAEL,gBAAgB,EAChB,SAAS,GACV,MAAM,0BAA0B,CAAC;AAIlC,MAAM,CAAC,MAAM,qBAAqB,GAChC,4CAA4C,CAAC;AAE/C;;;;GAIG;AACH,MAAM,OAAO,SAAS;IACX,OAAO,CAAgB;IACvB,MAAM,CAAqB;IAC3B,QAAQ,CAAC;IAElB,YAAY,EACV,WAAW,EACX,KAAK,GAAG,qBAAqB,EAC7B,QAAQ,GAAG,oBAAoB,EAC/B,QAAQ,GAAG,QAAQ,EACnB,MAAM,GACU;QAChB,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IACxD,CAAC;IAED,mEAAmE;IACnE,KAAK,CAAC,QAAQ;QACZ,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAChC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACtD,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,IAAI,EAAE;gBACzD,IAAI,CAAC;oBACH,MAAM,YAAY,CAChB,SAAS,EACT,SAAS,CAAC,SAAS,EACnB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EACtB,QAAQ,CACT,CAAC;gBACJ,CAAC;gBAAC,MAAM,CAAC;oBACP,sEAAsE;gBACxE,CAAC;wBAAS,CAAC;oBACT,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;gBAC/B,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;YAC7B,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,wEAAwE;IACxE,KAAK,CAAC,KAAK;QACT,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACtD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,CACnD,SAAS,CAAC,OAAO,EAAE,CACpB,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,SAAS,CAAC,OAAO,EAAE,CAAC;YAC1B,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAoB;QACtC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC1D,CAAC;IAED,iBAAiB,CAAC,SAA2B,EAAE,QAAgB;QAC7D,OAAO,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,SAA2B;QACrC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,cAAc,CACjC,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,6CAA6C,CAC5F,CAAC;QACF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACzC,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,SAA2B,EAC3B,QAAgB;QAEhB,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,cAAc,CACjC,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAC5C,CAAC;QACF,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,MAAM,IAAI;iBACP,OAAO,EAAE;iBACT,KAAK,CACJ,4DAA4D,QAAQ,uBAAuB,QAAQ,GAAG,CACvG,CAAC;QACN,CAAC;gBAAS,CAAC;YACT,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;IAED,QAAQ,CAAC,KAAa,EAAE,IAAuB;QAC7C,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CACvB;YACE,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,IAAI,EAAE;YACnD,GAAG,EAAE;gBACH,eAAe;gBACf,qBAAqB,QAAQ,EAAE;gBAC/B,4BAA4B;gBAC5B,mBAAmB;aACpB;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,gBAAgB,EAAE,sBAAsB,EAAE;gBACnD,MAAM,EAAE,CAAC,GAAG,IAAI,IAAI,CAAC;gBACrB,gBAAgB,EAAE,CAAC;aACpB;SACF,EACD;YACE,YAAY,EAAE,IAAI;YAClB,OAAO,EAAE,CAAC,SAAS,EAAE,EAAE,CACrB,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;SAClE,CACF,CAAC;IACJ,CAAC;IAED,OAAO,CACL,SAA2B,EAC3B,KAAa,EACb,QAAgB,EAChB,OAA4B;QAE5B,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QACnC,OAAO;YACL,gBAAgB,EAAE,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,QAAQ,CAAC;YAC7D,KAAK;YACL,IAAI,EAAE,IAAI;YACV,QAAQ;YACR,QAAQ;YACR,WAAW,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE;YACnC,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,OAAO;YACP,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO;SAC/B,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { type Clock } from '@zukhruf/async';
|
|
2
|
+
import { type Docker, type EngineApi } from '@zukhruf/docker';
|
|
3
|
+
/** An official Docker CLI image, pinned (ADR 0020, item 10). */
|
|
4
|
+
export declare const REAPER_IMAGE = "docker:28.5.2-cli";
|
|
5
|
+
/** Marks the reaper of a run, with the run's id. It is not the run's label: the reaper would remove itself. */
|
|
6
|
+
export declare const REAPER_LABEL = "dev.zukhruf.testing.reaper";
|
|
7
|
+
/** Marks a server that `reuse()` shares (ADR 0019). */
|
|
8
|
+
export declare const SERVER_LABEL = "dev.zukhruf.testing.server";
|
|
9
|
+
/** The inputs of a reaper, in milliseconds where they are times (ADR 0020, item 4). */
|
|
10
|
+
export interface ReaperSettings {
|
|
11
|
+
/** The wait after the last holder ended, before the first pass. */
|
|
12
|
+
grace: number;
|
|
13
|
+
/** The wait between two passes. */
|
|
14
|
+
interval: number;
|
|
15
|
+
/** The passes after the first one. */
|
|
16
|
+
passes: number;
|
|
17
|
+
/** The time limit of each request to the engine. */
|
|
18
|
+
requestTimeout: number;
|
|
19
|
+
/** The tries of a removal after its first one. */
|
|
20
|
+
retries: number;
|
|
21
|
+
/** The wait for a first holder, after the start. */
|
|
22
|
+
firstHolder: number;
|
|
23
|
+
/** The age from which the reaper removes a shared server that no process lease holds (ADR 0019). */
|
|
24
|
+
serverTtl: number;
|
|
25
|
+
/** How long the reaper waits for the sweep lease of one server that another holder has (ADR 0014). */
|
|
26
|
+
sweepWait: number;
|
|
27
|
+
/** The tries to take the sweep lease of one server. */
|
|
28
|
+
sweepTries: number;
|
|
29
|
+
/** The time a `created` sweep lease gets to start before the reaper removes it. */
|
|
30
|
+
leasePatience: number;
|
|
31
|
+
}
|
|
32
|
+
/** The values of the probe and of Ryuk, and of ADR 0014 and ADR 0019. */
|
|
33
|
+
export declare const REAPER_DEFAULTS: ReaperSettings;
|
|
34
|
+
/** The name of the reaper of the run `runId` on an engine: one reaper for each run (ADR 0020, item 7). */
|
|
35
|
+
export declare const reaperName: (runId: string) => string;
|
|
36
|
+
/** The body of the reaper of the run `runId`, with its inputs in its environment. */
|
|
37
|
+
export declare function reaperRequest(runId: string, settings: ReaperSettings): EngineApi.ContainerCreateRequest;
|
|
38
|
+
/**
|
|
39
|
+
* The longest that a reaper can run after it closed its door: its first pass
|
|
40
|
+
* and its re-check passes, `interval` apart, its expiry pass with one sweep,
|
|
41
|
+
* and the start of one reaper left `created`. A pass makes four removals (the list and the removal of the
|
|
42
|
+
* containers, then of the volumes), each with its first try and `retries`
|
|
43
|
+
* more, `interval` apart and each within `requestTimeout`, and one list of the
|
|
44
|
+
* shared servers. The expiry pass lists the servers and, for one expired
|
|
45
|
+
* server, inspects it, waits `sweepWait` at most for its sweep lease, lists
|
|
46
|
+
* its process leases and removes it. The start of a reaper left `created`
|
|
47
|
+
* lists them, inspects one twice and starts it. Each database to drop, each
|
|
48
|
+
* other expired server and each other reaper to start adds to this, so a hold
|
|
49
|
+
* that waits longer fails.
|
|
50
|
+
*/
|
|
51
|
+
export declare function closingTime(settings: ReaperSettings): number;
|
|
52
|
+
/**
|
|
53
|
+
* The hold of this process on the reaper of its run: one `cat` exec with
|
|
54
|
+
* `ref: false` that holds the door of the reaper (ADR 0020, item 7). It ends
|
|
55
|
+
* when this process exits, for any reason. When it ends while this process
|
|
56
|
+
* lives, it is taken again at once: on the same reaper, or on the next one
|
|
57
|
+
* when that reaper closed.
|
|
58
|
+
*/
|
|
59
|
+
export declare class ReaperHold {
|
|
60
|
+
#private;
|
|
61
|
+
private constructor();
|
|
62
|
+
/**
|
|
63
|
+
* Holds the reaper of `runId`, and creates it when the run has none on this
|
|
64
|
+
* engine. A reaper that closed is waited for until the engine removed it,
|
|
65
|
+
* and one that ends while the hold starts is tried again: at most
|
|
66
|
+
* `settings.retries` more times.
|
|
67
|
+
*/
|
|
68
|
+
static take(docker: Docker, runId: string, settings: ReaperSettings, clock: Clock): Promise<ReaperHold>;
|
|
69
|
+
/**
|
|
70
|
+
* Resolves when this process holds the reaper: at once while the hold
|
|
71
|
+
* lasts, and after the new hold when it ended. A hold that failed is tried
|
|
72
|
+
* again by the next call.
|
|
73
|
+
*/
|
|
74
|
+
held(): Promise<void>;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Starts the reaper of the dead run `runId` with no wait for a first holder,
|
|
78
|
+
* and does not wait for it (ADR 0020, item 9). A reaper of the run that still
|
|
79
|
+
* runs keeps the run. One that ended is replaced, at most `settings.retries`
|
|
80
|
+
* more times.
|
|
81
|
+
*/
|
|
82
|
+
export declare function startReaper(docker: Docker, runId: string, settings?: ReaperSettings): Promise<void>;
|
|
83
|
+
/**
|
|
84
|
+
* The names that start with `test` in each running shared server: the
|
|
85
|
+
* superset of a run's databases that the reaper's pass filters (ADR 0011,
|
|
86
|
+
* item 4). A server that does not run, or does not answer its list within
|
|
87
|
+
* `settings.requestTimeout`, counts as one with none (ADR 0011, item 6).
|
|
88
|
+
*/
|
|
89
|
+
export declare function sharedDatabases(docker: Docker, settings: ReaperSettings, clock: Clock): Promise<string[]>;
|
|
90
|
+
/**
|
|
91
|
+
* Whether the engine holds nothing of the run `runId`: no reaper of it, and
|
|
92
|
+
* nothing that one would remove, its containers but its shared servers, its
|
|
93
|
+
* volumes, and its databases among `databases` (ADR 0020, item 9).
|
|
94
|
+
*/
|
|
95
|
+
export declare function reaped(docker: Docker, runId: string, databases: () => Promise<readonly string[]>): Promise<boolean>;
|
|
96
|
+
//# sourceMappingURL=reaper.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reaper.d.ts","sourceRoot":"","sources":["../../src/docker/reaper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAA+B,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAIL,KAAK,MAAM,EACX,KAAK,SAAS,EAIf,MAAM,iBAAiB,CAAC;AAkBzB,gEAAgE;AAChE,eAAO,MAAM,YAAY,sBAAsB,CAAC;AAEhD,+GAA+G;AAC/G,eAAO,MAAM,YAAY,+BAA+B,CAAC;AAEzD,uDAAuD;AACvD,eAAO,MAAM,YAAY,+BAA+B,CAAC;AAEzD,uFAAuF;AACvF,MAAM,WAAW,cAAc;IAC7B,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,cAAc,EAAE,MAAM,CAAC;IACvB,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,WAAW,EAAE,MAAM,CAAC;IACpB,oGAAoG;IACpG,SAAS,EAAE,MAAM,CAAC;IAClB,sGAAsG;IACtG,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,mFAAmF;IACnF,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,yEAAyE;AACzE,eAAO,MAAM,eAAe,EAAE,cAW7B,CAAC;AAEF,0GAA0G;AAC1G,eAAO,MAAM,UAAU,GAAI,OAAO,MAAM,KAAG,MACR,CAAC;AA2NpC,qFAAqF;AACrF,wBAAgB,aAAa,CAC3B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,cAAc,GACvB,SAAS,CAAC,sBAAsB,CAwBlC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,CAO5D;AAsHD;;;;;;GAMG;AACH,qBAAa,UAAU;;IAMrB,OAAO;IAYP;;;;;OAKG;WACU,IAAI,CACf,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,UAAU,CAAC;IAMtB;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAsE5B;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,QAAQ,GAAE,cAAgC,GACzC,OAAO,CAAC,IAAI,CAAC,CAQf;AAED;;;;;GAKG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,KAAK,GACX,OAAO,CAAC,MAAM,EAAE,CAAC,CAyCnB;AAED;;;;GAIG;AACH,wBAAsB,MAAM,CAC1B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,OAAO,CAAC,SAAS,MAAM,EAAE,CAAC,GAC1C,OAAO,CAAC,OAAO,CAAC,CAUlB"}
|