feat: Generalize RootInitializer to ContainerInitializer

The initializer can now be used for any container. The initializer also does not handle the repeat check anymore, this is now configured with a ConditionalHandler.
2024-10-03 14:55:10 +00:00 · 2021-10-07 09:55:44 +02:00
parent bb7e88b137
commit 9968f2ae5b
7 changed files with 184 additions and 172 deletions
--- a/test/unit/init/ContainerInitializer.test.ts
+++ b/test/unit/init/ContainerInitializer.test.ts
@@ -0,0 +1,73 @@
+import { ContainerInitializer } from '../../../src/init/ContainerInitializer';
+import type { Logger } from '../../../src/logging/Logger';
+import { getLoggerFor } from '../../../src/logging/LogUtil';
+import type { Resource, ResourcesGenerator } from '../../../src/pods/generate/ResourcesGenerator';
+import type { KeyValueStorage } from '../../../src/storage/keyvalue/KeyValueStorage';
+import type { ResourceStore } from '../../../src/storage/ResourceStore';
+
+jest.mock('../../../src/logging/LogUtil', (): any => {
+  const logger: Logger = { warn: jest.fn(), debug: jest.fn(), info: jest.fn() } as any;
+  return { getLoggerFor: (): Logger => logger };
+});
+
+describe('A ContainerInitializer', (): void => {
+  const baseUrl = 'http://test.com/';
+  const path = 'foo/';
+  let store: jest.Mocked<ResourceStore>;
+  let generatorData: Resource[];
+  let generator: jest.Mocked<ResourcesGenerator>;
+  const storageKey = 'done';
+  let storage: jest.Mocked<KeyValueStorage<string, boolean>>;
+  let initializer: ContainerInitializer;
+  let logger: jest.Mocked<Logger>;
+
+  beforeEach(async(): Promise<void> => {
+    store = {
+      setRepresentation: jest.fn(),
+    } as any;
+
+    generatorData = [
+      { identifier: { path: '/.acl' }, representation: '/.acl' as any },
+      { identifier: { path: '/container/' }, representation: '/container/' as any },
+    ];
+    generator = {
+      generate: jest.fn(async function* (): any {
+        yield* generatorData;
+      }),
+    } as any;
+
+    const map = new Map();
+    storage = {
+      get: jest.fn((id: string): any => map.get(id)),
+      set: jest.fn((id: string, value: any): any => map.set(id, value)),
+    } as any;
+
+    initializer = new ContainerInitializer({
+      baseUrl,
+      path,
+      store,
+      generator,
+      storageKey,
+      storage,
+    });
+    logger = getLoggerFor(initializer) as any;
+    jest.clearAllMocks();
+  });
+
+  it('writes resources and sets the storage value to true.', async(): Promise<void> => {
+    await expect(initializer.handle()).resolves.toBeUndefined();
+    expect(generator.generate).toHaveBeenCalledTimes(1);
+    expect(store.setRepresentation).toHaveBeenCalledTimes(2);
+    expect(storage.get(storageKey)).toBe(true);
+  });
+
+  it('logs warnings if there was a problem creating a resource.', async(): Promise<void> => {
+    store.setRepresentation.mockRejectedValueOnce(new Error('bad input'));
+
+    await expect(initializer.handle()).resolves.toBeUndefined();
+    expect(generator.generate).toHaveBeenCalledTimes(1);
+    expect(store.setRepresentation).toHaveBeenCalledTimes(2);
+    expect(logger.warn).toHaveBeenCalledTimes(1);
+    expect(logger.warn).toHaveBeenLastCalledWith('Failed to create resource /.acl: bad input');
+  });
+});
--- a/test/unit/init/RootInitializer.test.ts
+++ b/test/unit/init/RootInitializer.test.ts
@@ -1,82 +0,0 @@
-import { RootInitializer } from '../../../src/init/RootInitializer';
-import { BasicRepresentation } from '../../../src/ldp/representation/BasicRepresentation';
-import { RepresentationMetadata } from '../../../src/ldp/representation/RepresentationMetadata';
-import type { Logger } from '../../../src/logging/Logger';
-import { getLoggerFor } from '../../../src/logging/LogUtil';
-import type { Resource, ResourcesGenerator } from '../../../src/pods/generate/ResourcesGenerator';
-import type { ResourceStore } from '../../../src/storage/ResourceStore';
-import { NotFoundHttpError } from '../../../src/util/errors/NotFoundHttpError';
-import { PIM, RDF } from '../../../src/util/Vocabularies';
-
-jest.mock('../../../src/logging/LogUtil', (): any => {
-  const logger: Logger = { warn: jest.fn(), debug: jest.fn(), info: jest.fn() } as any;
-  return { getLoggerFor: (): Logger => logger };
-});
-
-describe('A RootInitializer', (): void => {
-  const baseUrl = 'http://test.com/foo/';
-  let store: jest.Mocked<ResourceStore>;
-  let generatorData: Resource[];
-  let generator: jest.Mocked<ResourcesGenerator>;
-  let initializer: RootInitializer;
-  let logger: jest.Mocked<Logger>;
-
-  beforeEach(async(): Promise<void> => {
-    store = {
-      getRepresentation: jest.fn().mockRejectedValue(new NotFoundHttpError()),
-      setRepresentation: jest.fn(),
-    } as any;
-
-    generatorData = [
-      { identifier: { path: '/.acl' }, representation: '/.acl' as any },
-      { identifier: { path: '/container/' }, representation: '/container/' as any },
-    ];
-    generator = {
-      generate: jest.fn(async function* (): any {
-        yield* generatorData;
-      }),
-    } as any;
-
-    initializer = new RootInitializer(baseUrl, store, generator);
-    logger = getLoggerFor(initializer) as any;
-    jest.clearAllMocks();
-  });
-
-  it('does nothing is the root container already has pim:Storage metadata.', async(): Promise<void> => {
-    const metadata = new RepresentationMetadata({ path: baseUrl }, { [RDF.type]: PIM.terms.Storage });
-    store.getRepresentation.mockResolvedValueOnce(new BasicRepresentation('data', metadata));
-
-    await expect(initializer.handle()).resolves.toBeUndefined();
-    expect(generator.generate).toHaveBeenCalledTimes(0);
-    expect(store.setRepresentation).toHaveBeenCalledTimes(0);
-  });
-
-  it('writes new resources if the container does not exist yet.', async(): Promise<void> => {
-    await expect(initializer.handle()).resolves.toBeUndefined();
-    expect(generator.generate).toHaveBeenCalledTimes(1);
-    expect(store.setRepresentation).toHaveBeenCalledTimes(2);
-  });
-
-  it('writes new resources if the container is not a pim:Storage.', async(): Promise<void> => {
-    store.getRepresentation.mockResolvedValueOnce(new BasicRepresentation('data', 'text/string'));
-
-    await expect(initializer.handle()).resolves.toBeUndefined();
-    expect(generator.generate).toHaveBeenCalledTimes(1);
-    expect(store.setRepresentation).toHaveBeenCalledTimes(2);
-  });
-
-  it('throws an error if there is a problem accessing the root container.', async(): Promise<void> => {
-    store.getRepresentation.mockRejectedValueOnce(new Error('bad data'));
-    await expect(initializer.handle()).rejects.toThrow('bad data');
-  });
-
-  it('logs warnings if there was a problem creating a resource.', async(): Promise<void> => {
-    store.setRepresentation.mockRejectedValueOnce(new Error('bad input'));
-
-    await expect(initializer.handle()).resolves.toBeUndefined();
-    expect(generator.generate).toHaveBeenCalledTimes(1);
-    expect(store.setRepresentation).toHaveBeenCalledTimes(2);
-    expect(logger.warn).toHaveBeenCalledTimes(1);
-    expect(logger.warn).toHaveBeenLastCalledWith('Failed to create resource /.acl: bad input');
-  });
-});