feat: Integrate setup behaviour

This adds options for enabling setup to the config folder.
All default configs with permanent storage (file/sparql)
are configured to require setup at server start.
Memory-based configs merely have it as an option.

test/integration/LdpHandlerWithoutAuth.test.ts

@@ -72,13 +72,6 @@ describe.each(stores)('An LDP handler allowing all requests %s', (name, { storeC
     expect(response.headers.get('link')).toContain(`<${PIM.Storage}>; rel="type"`);
   });
 
-  it('can read the root container index page when asking for HTML.', async(): Promise<void> => {
-    const response = await getResource(baseUrl, { accept: 'text/html' }, { contentType: 'text/html' });
-
-    await expect(response.text()).resolves.toContain('Welcome to Solid');
-    expect(response.headers.get('link')).toContain(`<${PIM.Storage}>; rel="type"`);
-  });
-
   it('can read a container listing with a query string.', async(): Promise<void> => {
     // Helper functions would fail due to query params
     const response = await fetch(`${baseUrl}?abc=def&xyz`, { headers: { accept: 'text/turtle' }});
@@ -92,9 +85,6 @@ describe.each(stores)('An LDP handler allowing all requests %s', (name, { storeC
     const quads = parser.parse(await response.text());
     const store = new Store(quads);
     expect(store.countQuads(namedNode(baseUrl), RDF.terms.type, LDP.terms.Container, null)).toBe(1);
-    const contains = store.getObjects(namedNode(baseUrl), LDP.terms.contains, null);
-    expect(contains).toHaveLength(1);
-    expect(contains[0].value).toBe(`${baseUrl}index.html`);
   });
 
   it('can add a document to the store, read it and delete it.', async(): Promise<void> => {

test/integration/Setup.test.ts

@@ -0,0 +1,117 @@
+import fetch from 'cross-fetch';
+import type { App } from '../../src/init/App';
+import { joinUrl } from '../../src/util/PathUtil';
+import { getPort } from '../util/Util';
+import { getDefaultVariables, getTestConfigPath, instantiateFromConfig } from './Config';
+
+const port = getPort('SetupMemory');
+const baseUrl = `http://localhost:${port}/`;
+
+// Some tests with real Requests/Responses until the mocking library has been removed from the tests
+describe('A Solid server with setup', (): void => {
+  const email = 'test@test.email';
+  const password = 'password!';
+  const podName = 'test';
+  const setupUrl = joinUrl(baseUrl, '/setup');
+  let app: App;
+
+  // `beforeEach` since the server needs to restart to reset setup
+  beforeEach(async(): Promise<void> => {
+    const instances = await instantiateFromConfig(
+      'urn:solid-server:test:Instances',
+      getTestConfigPath('setup-memory.json'),
+      getDefaultVariables(port, baseUrl),
+    ) as Record<string, any>;
+    ({ app } = instances);
+    await app.start();
+  });
+
+  afterEach(async(): Promise<void> => {
+    await app.stop();
+  });
+
+  it('catches all requests.', async(): Promise<void> => {
+    let res = await fetch(baseUrl, { method: 'GET', headers: { accept: 'text/html' }});
+    expect(res.status).toBe(200);
+    await expect(res.text()).resolves.toContain('Welcome to Solid');
+
+    res = await fetch(joinUrl(baseUrl, '/random/path/'), { method: 'GET', headers: { accept: 'text/html' }});
+    expect(res.status).toBe(200);
+    await expect(res.text()).resolves.toContain('Welcome to Solid');
+
+    res = await fetch(joinUrl(baseUrl, '/random/path/'), { method: 'PUT', headers: { accept: 'text/html' }});
+    expect(res.status).toBe(405);
+    await expect(res.text()).resolves.toContain('Welcome to Solid');
+  });
+
+  it('can create a server that disables root but allows registration.', async(): Promise<void> => {
+    let res = await fetch(setupUrl, { method: 'POST', headers: { accept: 'text/html' }});
+    expect(res.status).toBe(200);
+    await expect(res.text()).resolves.toContain('Server successfully set up');
+
+    // Root access disabled
+    res = await fetch(baseUrl);
+    expect(res.status).toBe(403);
+
+    // Registration still possible
+    const registerParams = { email, podName, password, confirmPassword: password, createWebId: true };
+    res = await fetch(joinUrl(baseUrl, 'idp/register'), {
+      method: 'POST',
+      headers: { accept: 'text/html', 'content-type': 'application/json' },
+      body: JSON.stringify(registerParams),
+    });
+    expect(res.status).toBe(200);
+
+    res = await fetch(joinUrl(baseUrl, podName, '/profile/card'));
+    expect(res.status).toBe(200);
+    await expect(res.text()).resolves.toContain('foaf:PersonalProfileDocument');
+  });
+
+  it('can create a server with a public root.', async(): Promise<void> => {
+    let res = await fetch(setupUrl, {
+      method: 'POST',
+      headers: { accept: 'text/html', 'content-type': 'application/json' },
+      body: JSON.stringify({ initialize: true }),
+    });
+    expect(res.status).toBe(200);
+    await expect(res.text()).resolves.toContain('Server successfully set up');
+
+    // Root access enabled
+    res = await fetch(baseUrl);
+    expect(res.status).toBe(200);
+    await expect(res.text()).resolves.toContain('<> a <http://www.w3.org/ns/pim/space#Storage>');
+
+    // Root pod registration is never allowed
+    const registerParams = { email, podName, password, confirmPassword: password, createWebId: true, rootPod: true };
+    res = await fetch(joinUrl(baseUrl, 'idp/register'), {
+      method: 'POST',
+      headers: { accept: 'text/html', 'content-type': 'application/json' },
+      body: JSON.stringify(registerParams),
+    });
+    expect(res.status).toBe(500);
+  });
+
+  it('can create a server with a root pod.', async(): Promise<void> => {
+    const registerParams = { email, podName, password, confirmPassword: password, createWebId: true, rootPod: true };
+    let res = await fetch(setupUrl, {
+      method: 'POST',
+      headers: { accept: 'text/html', 'content-type': 'application/json' },
+      body: JSON.stringify({ registration: true, initialize: true, ...registerParams }),
+    });
+    expect(res.status).toBe(200);
+    await expect(res.text()).resolves.toContain('Server successfully set up');
+
+    // Root profile created
+    res = await fetch(joinUrl(baseUrl, '/profile/card'));
+    expect(res.status).toBe(200);
+    await expect(res.text()).resolves.toContain('foaf:PersonalProfileDocument');
+
+    // Pod root is not accessible even though initialize was set to true
+    res = await fetch(joinUrl(baseUrl, 'resource'), {
+      method: 'PUT',
+      headers: { accept: 'text/html', 'content-type': 'text/plain' },
+      body: 'random data',
+    });
+    expect(res.status).toBe(401);
+  });
+});

test/integration/config/ldp-with-auth.json

@@ -2,7 +2,8 @@
   "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld",
   "import": [
     "files-scs:config/app/main/default.json",
-    "files-scs:config/app/init/default.json",
+    "files-scs:config/app/init/initialize-root.json",
+    "files-scs:config/app/setup/disabled.json",
     "files-scs:config/http/handler/simple.json",
     "files-scs:config/http/middleware/no-websockets.json",
     "files-scs:config/http/server-factory/no-websockets.json",

test/integration/config/run-with-redlock.json

@@ -2,7 +2,8 @@
   "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld",
   "import": [
     "files-scs:config/app/main/default.json",
-    "files-scs:config/app/init/default.json",
+    "files-scs:config/app/init/initialize-root.json",
+    "files-scs:config/app/setup/disabled.json",
     "files-scs:config/http/handler/simple.json",
     "files-scs:config/http/middleware/no-websockets.json",
     "files-scs:config/http/server-factory/no-websockets.json",

test/integration/config/server-dynamic-unsafe.json

@@ -2,7 +2,8 @@
   "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld",
   "import": [
     "files-scs:config/app/main/default.json",
-    "files-scs:config/app/init/default.json",
+    "files-scs:config/app/init/initialize-root.json",
+    "files-scs:config/app/setup/disabled.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/no-websockets.json",
     "files-scs:config/http/server-factory/no-websockets.json",

test/integration/config/server-memory.json

@@ -2,7 +2,8 @@
   "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld",
   "import": [
     "files-scs:config/app/main/default.json",
-    "files-scs:config/app/init/default.json",
+    "files-scs:config/app/init/initialize-root.json",
+    "files-scs:config/app/setup/disabled.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

test/integration/config/server-subdomains-unsafe.json

@@ -2,7 +2,8 @@
   "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld",
   "import": [
     "files-scs:config/app/main/default.json",
-    "files-scs:config/app/init/default.json",
+    "files-scs:config/app/init/initialize-root.json",
+    "files-scs:config/app/setup/disabled.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/no-websockets.json",
     "files-scs:config/http/server-factory/no-websockets.json",

test/integration/config/server-without-auth.json

@@ -2,7 +2,8 @@
   "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld",
   "import": [
     "files-scs:config/app/main/default.json",
-    "files-scs:config/app/init/default.json",
+    "files-scs:config/app/init/initialize-root.json",
+    "files-scs:config/app/setup/disabled.json",
     "files-scs:config/http/handler/default.json",
     "files-scs:config/http/middleware/websockets.json",
     "files-scs:config/http/server-factory/websockets.json",

test/integration/config/setup-memory.json

@@ -0,0 +1,45 @@
+{
+  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld",
+  "import": [
+    "files-scs:config/app/main/default.json",
+    "files-scs:config/app/init/default.json",
+    "files-scs:config/app/setup/required.json",
+    "files-scs:config/http/handler/default.json",
+    "files-scs:config/http/middleware/websockets.json",
+    "files-scs:config/http/server-factory/websockets.json",
+    "files-scs:config/http/static/default.json",
+    "files-scs:config/identity/email/default.json",
+    "files-scs:config/identity/handler/default.json",
+    "files-scs:config/identity/ownership/token.json",
+    "files-scs:config/identity/pod/static.json",
+    "files-scs:config/identity/registration/enabled.json",
+    "files-scs:config/ldp/authentication/dpop-bearer.json",
+    "files-scs:config/ldp/authorization/webacl.json",
+    "files-scs:config/ldp/handler/default.json",
+    "files-scs:config/ldp/metadata-parser/default.json",
+    "files-scs:config/ldp/metadata-writer/default.json",
+    "files-scs:config/ldp/permissions/acl.json",
+    "files-scs:config/storage/backend/memory.json",
+    "files-scs:config/storage/key-value/resource-store.json",
+    "files-scs:config/storage/middleware/default.json",
+    "files-scs:config/util/auxiliary/acl.json",
+    "files-scs:config/util/identifiers/suffix.json",
+    "files-scs:config/util/index/default.json",
+    "files-scs:config/util/logging/winston.json",
+    "files-scs:config/util/representation-conversion/default.json",
+    "files-scs:config/util/resource-locker/memory.json",
+    "files-scs:config/util/variables/default.json"
+  ],
+  "@graph": [
+    {
+      "@id": "urn:solid-server:test:Instances",
+      "@type": "RecordObject",
+      "RecordObject:_record": [
+        {
+          "RecordObject:_record_key": "app",
+          "RecordObject:_record_value": { "@id": "urn:solid-server:default:App" }
+        }
+      ]
+    }
+  ]
+}

test/unit/util/handlers/StaticHandler.test.ts

@@ -0,0 +1,18 @@
+import { StaticHandler } from '../../../../src/util/handlers/StaticHandler';
+
+describe('A StaticHandler', (): void => {
+  it('can handle everything.', async(): Promise<void> => {
+    const handler = new StaticHandler();
+    await expect(handler.canHandle(null)).resolves.toBeUndefined();
+  });
+
+  it('returns the stored value.', async(): Promise<void> => {
+    const handler = new StaticHandler('apple');
+    await expect(handler.handle()).resolves.toEqual('apple');
+  });
+
+  it('returns undefined if there is no stored value.', async(): Promise<void> => {
+    const handler = new StaticHandler();
+    await expect(handler.handle()).resolves.toBeUndefined();
+  });
+});

test/util/Util.ts

@@ -13,6 +13,7 @@ const portNames = [
   'PodCreation',
   'RedisResourceLocker',
   'ServerFetch',
+  'SetupMemory',
   'SparqlStorage',
   'Subdomains',
   'WebSocketsProtocol',