-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #307 from bijela-gora/tests/for-nodefs-storage
Tests suite for storage adapters
- Loading branch information
Showing
11 changed files
with
254 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
packages/automerge-repo-storage-nodefs/test/NodeFSStorageAdapter.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import * as fs from "node:fs" | ||
| import * as os from "node:os" | ||
| import * as path from "node:path" | ||
| import { describe } from "vitest" | ||
| import { runStorageAdapterTests } from "../../automerge-repo/src/helpers/tests/storage-adapter-tests" | ||
| import { NodeFSStorageAdapter } from "../src" | ||
|
|
||
| describe("NodeFSStorageAdapter", () => { | ||
| const setup = async () => { | ||
| const dir = fs.mkdtempSync(path.join(os.tmpdir(), "automerge-repo-tests")) | ||
| const teardown = () => { | ||
| fs.rmSync(dir, { force: true, recursive: true }) | ||
| } | ||
| const adapter = new NodeFSStorageAdapter(dir) | ||
| return { adapter, teardown } | ||
| } | ||
|
|
||
| runStorageAdapterTests(setup) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { defineConfig, mergeConfig } from "vitest/config" | ||
| import rootConfig from "../../vitest.config" | ||
|
|
||
| export default mergeConfig( | ||
| rootConfig, | ||
| defineConfig({ | ||
| test: { | ||
| environment: "node", | ||
| }, | ||
| }) | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
193 changes: 193 additions & 0 deletions
193
packages/automerge-repo/src/helpers/tests/storage-adapter-tests.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| import { describe, expect, it } from "vitest" | ||
|
|
||
| import type { StorageAdapterInterface } from "../../storage/StorageAdapterInterface.js" | ||
|
|
||
| const PAYLOAD_A = () => new Uint8Array([0, 1, 127, 99, 154, 235]) | ||
| const PAYLOAD_B = () => new Uint8Array([1, 76, 160, 53, 57, 10, 230]) | ||
| const PAYLOAD_C = () => new Uint8Array([2, 111, 74, 131, 236, 96, 142, 193]) | ||
|
|
||
| const LARGE_PAYLOAD = new Uint8Array(100000).map(() => Math.random() * 256) | ||
|
|
||
| export function runStorageAdapterTests(_setup: SetupFn, title?: string): void { | ||
| const setup = async () => { | ||
| const { adapter, teardown = NO_OP } = await _setup() | ||
| return { adapter, teardown } | ||
| } | ||
|
|
||
| describe(`Network adapter acceptance tests ${ | ||
| title ? `(${title})` : "" | ||
| }`, () => { | ||
| describe("load", () => { | ||
| it("should return undefined if there is no data", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| const actual = await adapter.load(["AAAAA", "sync-state", "xxxxx"]) | ||
| expect(actual).toBeUndefined() | ||
|
|
||
| teardown() | ||
| }) | ||
| }) | ||
|
|
||
| describe("save and load", () => { | ||
| it("should return data that was saved", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["storage-adapter-id"], PAYLOAD_A()) | ||
| const actual = await adapter.load(["storage-adapter-id"]) | ||
| expect(actual).toStrictEqual(PAYLOAD_A()) | ||
|
|
||
| teardown() | ||
| }) | ||
|
|
||
| it("should work with composite keys", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["AAAAA", "sync-state", "xxxxx"], PAYLOAD_A()) | ||
| const actual = await adapter.load(["AAAAA", "sync-state", "xxxxx"]) | ||
| expect(actual).toStrictEqual(PAYLOAD_A()) | ||
|
|
||
| teardown() | ||
| }) | ||
|
|
||
| it("should work with a large payload", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["AAAAA", "sync-state", "xxxxx"], LARGE_PAYLOAD) | ||
| const actual = await adapter.load(["AAAAA", "sync-state", "xxxxx"]) | ||
| expect(actual).toStrictEqual(LARGE_PAYLOAD) | ||
|
|
||
| teardown() | ||
| }) | ||
| }) | ||
|
|
||
| describe("loadRange", () => { | ||
| it("should return an empty array if there is no data", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| expect(await adapter.loadRange(["AAAAA"])).toStrictEqual([]) | ||
|
|
||
| teardown() | ||
| }) | ||
| }) | ||
|
|
||
| describe("save and loadRange", () => { | ||
| it("should return all the data that matches the key", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["AAAAA", "sync-state", "xxxxx"], PAYLOAD_A()) | ||
| await adapter.save(["AAAAA", "snapshot", "yyyyy"], PAYLOAD_B()) | ||
| await adapter.save(["AAAAA", "sync-state", "zzzzz"], PAYLOAD_C()) | ||
|
|
||
| expect(await adapter.loadRange(["AAAAA"])).toStrictEqual( | ||
| expect.arrayContaining([ | ||
| { key: ["AAAAA", "sync-state", "xxxxx"], data: PAYLOAD_A() }, | ||
| { key: ["AAAAA", "snapshot", "yyyyy"], data: PAYLOAD_B() }, | ||
| { key: ["AAAAA", "sync-state", "zzzzz"], data: PAYLOAD_C() }, | ||
| ]) | ||
| ) | ||
|
|
||
| expect(await adapter.loadRange(["AAAAA", "sync-state"])).toStrictEqual( | ||
| expect.arrayContaining([ | ||
| { key: ["AAAAA", "sync-state", "xxxxx"], data: PAYLOAD_A() }, | ||
| { key: ["AAAAA", "sync-state", "zzzzz"], data: PAYLOAD_C() }, | ||
| ]) | ||
| ) | ||
|
|
||
| teardown() | ||
| }) | ||
|
|
||
| it("should only load values that match they key", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["AAAAA", "sync-state", "xxxxx"], PAYLOAD_A()) | ||
| await adapter.save(["BBBBB", "sync-state", "zzzzz"], PAYLOAD_C()) | ||
|
|
||
| const actual = await adapter.loadRange(["AAAAA"]) | ||
| expect(actual).toStrictEqual( | ||
| expect.arrayContaining([ | ||
| { key: ["AAAAA", "sync-state", "xxxxx"], data: PAYLOAD_A() }, | ||
| ]) | ||
| ) | ||
| expect(actual).toStrictEqual( | ||
| expect.not.arrayContaining([ | ||
| { key: ["BBBBB", "sync-state", "zzzzz"], data: PAYLOAD_C() }, | ||
| ]) | ||
| ) | ||
|
|
||
| teardown() | ||
| }) | ||
| }) | ||
|
|
||
| describe("save and remove", () => { | ||
| it("after removing, should be empty", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["AAAAA", "snapshot", "xxxxx"], PAYLOAD_A()) | ||
| await adapter.remove(["AAAAA", "snapshot", "xxxxx"]) | ||
|
|
||
| expect(await adapter.loadRange(["AAAAA"])).toStrictEqual([]) | ||
| expect( | ||
| await adapter.load(["AAAAA", "snapshot", "xxxxx"]) | ||
| ).toBeUndefined() | ||
|
|
||
| teardown() | ||
| }) | ||
| }) | ||
|
|
||
| describe("save and save", () => { | ||
| it("should overwrite data saved with the same key", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["AAAAA", "sync-state", "xxxxx"], PAYLOAD_A()) | ||
| await adapter.save(["AAAAA", "sync-state", "xxxxx"], PAYLOAD_B()) | ||
|
|
||
| expect(await adapter.loadRange(["AAAAA", "sync-state"])).toStrictEqual([ | ||
| { key: ["AAAAA", "sync-state", "xxxxx"], data: PAYLOAD_B() }, | ||
| ]) | ||
|
|
||
| teardown() | ||
| }) | ||
| }) | ||
|
|
||
| describe("removeRange", () => { | ||
| it("should remove a range of records", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["AAAAA", "sync-state", "xxxxx"], PAYLOAD_A()) | ||
| await adapter.save(["AAAAA", "snapshot", "yyyyy"], PAYLOAD_B()) | ||
| await adapter.save(["AAAAA", "sync-state", "zzzzz"], PAYLOAD_C()) | ||
|
|
||
| await adapter.removeRange(["AAAAA", "sync-state"]) | ||
|
|
||
| expect(await adapter.loadRange(["AAAAA"])).toStrictEqual([ | ||
| { key: ["AAAAA", "snapshot", "yyyyy"], data: PAYLOAD_B() }, | ||
| ]) | ||
|
|
||
| teardown() | ||
| }) | ||
|
|
||
| it("should not remove records that don't match", async () => { | ||
| const { adapter, teardown } = await setup() | ||
|
|
||
| await adapter.save(["AAAAA", "sync-state", "xxxxx"], PAYLOAD_A()) | ||
| await adapter.save(["BBBBB", "sync-state", "zzzzz"], PAYLOAD_B()) | ||
|
|
||
| await adapter.removeRange(["AAAAA"]) | ||
|
|
||
| const actual = await adapter.loadRange(["BBBBB"]) | ||
| expect(actual).toStrictEqual([ | ||
| { key: ["BBBBB", "sync-state", "zzzzz"], data: PAYLOAD_B() }, | ||
| ]) | ||
|
|
||
| teardown() | ||
| }) | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| const NO_OP = () => {} | ||
|
|
||
| export type SetupFn = () => Promise<{ | ||
| adapter: StorageAdapterInterface | ||
| teardown?: () => void | ||
| }> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { beforeEach, describe } from "vitest" | ||
| import { DummyStorageAdapter } from "./helpers/DummyStorageAdapter.js" | ||
| import { runStorageAdapterTests } from "../src/helpers/tests/storage-adapter-tests.js" | ||
|
|
||
| describe("DummyStorageAdapter", () => { | ||
| const setup = async () => ({ | ||
| adapter: new DummyStorageAdapter(), | ||
| }) | ||
|
|
||
| runStorageAdapterTests(setup, "DummyStorageAdapter") | ||
| }) |