solid-server 5.8.7 → 5.8.8-8d509db1

package/test/integration/patch-test.mjs

@@ -0,0 +1,573 @@
+import { fileURLToPath } from 'url'
+import path from 'path'
+import fs from 'fs'
+// Import utility functions from the ESM utils
+import { read, rm, backup, restore } from '../utils.mjs'
+import { assert } from 'chai'
+import supertest from 'supertest'
+
+import ldnode from '../../index.mjs'
+// import ldnode from '../../index.mjs';
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+// Server settings
+const port = 7777
+const serverUri = `https://tim.localhost:${port}`
+const root = path.join(__dirname, '../resources/patch')
+const configPath = path.join(__dirname, '../resources/config')
+const serverOptions = {
+  root,
+  configPath,
+  serverUri,
+  multiuser: false,
+  webid: true,
+  sslKey: path.join(__dirname, '../keys/key.pem'),
+  sslCert: path.join(__dirname, '../keys/cert.pem'),
+  forceUser: `${serverUri}/profile/card#me`
+}
+
+describe('PATCH through text/n3', () => {
+  let request
+  let server
+
+  // Start the server
+  before(done => {
+    server = ldnode.createServer(serverOptions)
+    server.listen(port, done)
+    request = supertest(serverUri)
+    // console.log('Server started at ' + serverUri)
+  })
+
+  // Stop the server
+  after(() => {
+    server.close()
+  })
+
+  after(() => {
+    server.close()
+  })
+
+  describe('with a patch document', () => {
+    describe('with an unsupported content type', describePatch({
+      path: '/read-write.ttl',
+      patch: 'other syntax',
+      contentType: 'text/other'
+    }, { // expected:
+      status: 415,
+      text: 'Unsupported patch content type: text/other'
+    }))
+
+    describe('containing invalid syntax', describePatch({
+      path: '/read-write.ttl',
+      patch: 'invalid syntax'
+    }, { // expected:
+      status: 400,
+      text: 'Patch document syntax error'
+    }))
+
+    describe('without relevant patch element', describePatch({
+      path: '/read-write.ttl',
+      patch: '<> a solid:Patch.'
+    }, { // expected:
+      status: 400,
+      text: 'No n3-patch found'
+    }))
+
+    describe('with neither insert nor delete', describePatch({
+      path: '/read-write.ttl',
+      patch: '<> a solid:InsertDeletePatch.'
+    }, { // expected:
+      status: 400,
+      text: 'Patch should at least contain inserts or deletes'
+    }))
+  })
+
+  describe('with insert', () => {
+    describe('on a non-existing file', describePatch({
+      path: '/new.ttl',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. }.`
+    }, { // expected:
+      status: 201,
+      text: 'Patch applied successfully',
+      result: '@prefix : </new.ttl#>.\n@prefix tim: </>.\n\ntim:x tim:y tim:z.\n\n'
+    }))
+
+    describe('on a non-existent JSON-LD file', describePatch({
+      path: '/new.jsonld',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. }.`
+    }, { // expected:
+      status: 201,
+      text: 'Patch applied successfully',
+      // result: '{\n  "@id": "/x",\n  "/y": {\n    "@id": "/z"\n  }\n}'
+      result: `{
+  "@context": {
+    "tim": "https://tim.localhost:7777/"
+  },
+  "@id": "tim:x",
+  "tim:y": {
+    "@id": "tim:z"
+  }
+}`
+    }))
+
+    describe('on a non-existent RDF+XML file', describePatch({
+      path: '/new.rdf',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. }.`
+    }, { // expected:
+      status: 201,
+      text: 'Patch applied successfully',
+      result: `<rdf:RDF
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:tim="https://tim.localhost:7777/">
+   <rdf:Description rdf:about="/x"><tim:y rdf:resource="/z"/></rdf:Description>
+</rdf:RDF>
+`
+    }))
+
+    describe('on a non-existent N3 file', describePatch({
+      path: '/new.n3',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. }.`
+    }, { // expected:
+      status: 201,
+      text: 'Patch applied successfully',
+      result: '@prefix : </new.n3#>.\n@prefix tim: </>.\n\ntim:x tim:y tim:z.\n\n'
+    }))
+
+    describe('on an N3 file that has an invalid uri (*.acl)', describePatch({
+      path: '/foo/bar.acl/test.n3',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. }.`
+    }, {
+      status: 400,
+      text: 'contained reserved suffixes in path'
+    }))
+
+    describe('on an N3 file that has an invalid uri (*.meta)', describePatch({
+      path: '/foo/bar/xyz.meta/test.n3',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:insers { <x> <y> <z>. }.`
+    }, {
+      status: 400,
+      text: 'contained reserved suffixes in path'
+    }))
+
+    describe('on a resource with read-only access', describePatch({
+      path: '/read-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with append-only access', describePatch({
+      path: '/append-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. }.`
+    }, { // expected:
+      status: 200,
+      text: 'Patch applied successfully',
+      result: '@prefix : </append-only.ttl#>.\n@prefix tim: </>.\n\ntim:a tim:b tim:c.\n\ntim:d tim:e tim:f.\n\ntim:x tim:y tim:z.\n\n'
+    }))
+
+    describe('on a resource with write-only access', describePatch({
+      path: '/write-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. }.`
+    }, { // expected:
+      status: 200,
+      text: 'Patch applied successfully',
+      result: '@prefix : </write-only.ttl#>.\n@prefix tim: </>.\n\ntim:a tim:b tim:c.\n\ntim:d tim:e tim:f.\n\ntim:x tim:y tim:z.\n\n'
+    }))
+
+    describe('on a resource with parent folders that do not exist', describePatch({
+      path: '/folder/cool.ttl',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+        solid:inserts { <x> <y> <z>. }.`
+    }, {
+      status: 201,
+      text: 'Patch applied successfully',
+      result: '@prefix : <#>.\n@prefix fol: <./>.\n\nfol:x fol:y fol:z.\n\n'
+    }))
+  })
+
+  describe('with insert and where', () => {
+    describe('on a non-existing file', describePatch({
+      path: '/new.ttl',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { ?a <y> <z>. };
+                 solid:where   { ?a <b> <c>. }.`
+    }, { // expected:
+      status: 409,
+      text: 'The patch could not be applied'
+    }))
+
+    describe('on a resource with read-only access', describePatch({
+      path: '/read-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { ?a <y> <z>. };
+                 solid:where   { ?a <b> <c>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with append-only access', describePatch({
+      path: '/append-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { ?a <y> <z>. };
+                 solid:where   { ?a <b> <c>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with write-only access', describePatch({
+      path: '/write-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { ?a <y> <z>. };
+                 solid:where   { ?a <b> <c>. }.`
+    }, { // expected:
+      // Allowing the insert would either return 200 or 409,
+      // thereby inappropriately giving the user (guess-based) read access;
+      // therefore, we need to return 403.
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with read-append access', () => {
+      describe('with a matching WHERE clause', describePatch({
+        path: '/read-append.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:inserts { ?a <y> <z>. };
+                   solid:where   { ?a <b> <c>. }.`
+      }, { // expected:
+        status: 200,
+        text: 'Patch applied successfully',
+        result: '@prefix : </read-append.ttl#>.\n@prefix tim: </>.\n\ntim:a tim:b tim:c; tim:y tim:z.\n\ntim:d tim:e tim:f.\n\n'
+      }))
+
+      describe('with a non-matching WHERE clause', describePatch({
+        path: '/read-append.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:where   { ?a <y> <z>. };
+                   solid:inserts { ?a <s> <t>. }.`
+      }, { // expected:
+        status: 409,
+        text: 'The patch could not be applied'
+      }))
+    })
+
+    describe('on a resource with read-write access', () => {
+      describe('with a matching WHERE clause', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:inserts { ?a <y> <z>. };
+                   solid:where   { ?a <b> <c>. }.`
+      }, { // expected:
+        status: 200,
+        text: 'Patch applied successfully',
+        result: '@prefix : </read-write.ttl#>.\n@prefix tim: </>.\n\ntim:a tim:b tim:c; tim:y tim:z.\n\ntim:d tim:e tim:f.\n\n'
+      }))
+
+      describe('with a non-matching WHERE clause', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:where   { ?a <y> <z>. };
+                   solid:inserts { ?a <s> <t>. }.`
+      }, { // expected:
+        status: 409,
+        text: 'The patch could not be applied'
+      }))
+    })
+  })
+
+  describe('with delete', () => {
+    describe('on a non-existing file', describePatch({
+      path: '/new.ttl',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      status: 409,
+      text: 'The patch could not be applied'
+    }))
+
+    describe('on a resource with read-only access', describePatch({
+      path: '/read-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with append-only access', describePatch({
+      path: '/append-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with write-only access', describePatch({
+      path: '/write-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      // Allowing the delete would either return 200 or 409,
+      // thereby inappropriately giving the user (guess-based) read access;
+      // therefore, we need to return 403.
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with read-append access', describePatch({
+      path: '/read-append.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with read-write access', () => {
+      describe('with a patch for existing data', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:deletes { <a> <b> <c>. }.`
+      }, { // expected:
+        status: 200,
+        text: 'Patch applied successfully',
+        result: '@prefix : </read-write.ttl#>.\n@prefix tim: </>.\n\ntim:d tim:e tim:f.\n\n'
+      }))
+
+      describe('with a patch for non-existing data', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:deletes { <x> <y> <z>. }.`
+      }, { // expected:
+        status: 409,
+        text: 'The patch could not be applied'
+      }))
+
+      describe('with a matching WHERE clause', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:where   { ?a <b> <c>. };
+                   solid:deletes { ?a <b> <c>. }.`
+      }, { // expected:
+        status: 200,
+        text: 'Patch applied successfully',
+        result: '@prefix : </read-write.ttl#>.\n@prefix tim: </>.\n\ntim:d tim:e tim:f.\n\n'
+      }))
+
+      describe('with a non-matching WHERE clause', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:where   { ?a <y> <z>. };
+                   solid:deletes { ?a <b> <c>. }.`
+      }, { // expected:
+        status: 409,
+        text: 'The patch could not be applied'
+      }))
+    })
+  })
+
+  describe('deleting and inserting', () => {
+    describe('on a non-existing file', describePatch({
+      path: '/new.ttl',
+      exists: false,
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. };
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      status: 409,
+      text: 'The patch could not be applied'
+    }))
+
+    describe('on a resource with read-only access', describePatch({
+      path: '/read-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. };
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with append-only access', describePatch({
+      path: '/append-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. };
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with write-only access', describePatch({
+      path: '/write-only.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. };
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      // Allowing the delete would either return 200 or 409,
+      // thereby inappropriately giving the user (guess-based) read access;
+      // therefore, we need to return 403.
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with read-append access', describePatch({
+      path: '/read-append.ttl',
+      patch: `<> a solid:InsertDeletePatch;
+                 solid:inserts { <x> <y> <z>. };
+                 solid:deletes { <a> <b> <c>. }.`
+    }, { // expected:
+      status: 403,
+      text: 'GlobalDashboard'
+    }))
+
+    describe('on a resource with read-write access', () => {
+      describe('executes deletes before inserts', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:inserts { <x> <y> <z>. };
+                   solid:deletes { <x> <y> <z>. }.`
+      }, { // expected:
+        status: 409,
+        text: 'The patch could not be applied'
+      }))
+
+      describe('with a patch for existing data', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:inserts { <x> <y> <z>. };
+                   solid:deletes { <a> <b> <c>. }.`
+      }, { // expected:
+        status: 200,
+        text: 'Patch applied successfully',
+        result: '@prefix : </read-write.ttl#>.\n@prefix tim: </>.\n\ntim:d tim:e tim:f.\n\ntim:x tim:y tim:z.\n\n'
+      }))
+
+      describe('with a patch for non-existing data', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:inserts { <x> <y> <z>. };
+                   solid:deletes { <q> <s> <s>. }.`
+      }, { // expected:
+        status: 409,
+        text: 'The patch could not be applied'
+      }))
+
+      describe('with a matching WHERE clause', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:where   { ?a <b> <c>. };
+                   solid:inserts { ?a <y> <z>. };
+                   solid:deletes { ?a <b> <c>. }.`
+      }, { // expected:
+        status: 200,
+        text: 'Patch applied successfully',
+        result: '@prefix : </read-write.ttl#>.\n@prefix tim: </>.\n\ntim:a tim:y tim:z.\n\ntim:d tim:e tim:f.\n\n'
+      }))
+
+      describe('with a non-matching WHERE clause', describePatch({
+        path: '/read-write.ttl',
+        patch: `<> a solid:InsertDeletePatch;
+                   solid:where   { ?a <y> <z>. };
+                   solid:inserts { ?a <y> <z>. };
+                   solid:deletes { ?a <b> <c>. }.`
+      }, { // expected:
+        status: 409,
+        text: 'The patch could not be applied'
+      }))
+    })
+  })
+
+  // Creates a PATCH test for the given resource with the given expected outcomes
+  function describePatch ({ path, exists = true, patch, contentType = 'text/n3' },
+    { status = 200, text, result }) {
+    return () => {
+      const filename = `patch${path}`
+      let originalContents
+      // Back up and restore an existing file
+      if (exists) {
+        before(() => backup(filename))
+        after(() => restore(filename))
+        // Store its contents to verify non-modification
+        if (!result) {
+          originalContents = read(filename)
+        }
+      // Ensure a non-existing file is removed
+      } else {
+        before(() => rm(filename))
+        after(() => rm(filename))
+      }
+
+      // Create the request and obtain the response
+      let response
+      before((done) => {
+        request.patch(path)
+          .set('Content-Type', contentType)
+          .send(`@prefix solid: <http://www.w3.org/ns/solid/terms#>.\n${patch}`)
+          .then(res => { response = res })
+          .then(done, done)
+      })
+
+      // Verify the response's status code and body text
+      it(`returns HTTP status code ${status}`, () => {
+        assert.isObject(response)
+        assert.equal(response.statusCode, status)
+      })
+      it(`has "${text}" in the response`, () => {
+        assert.isObject(response)
+        assert.include(response.text, text)
+      })
+
+      // For existing files, verify correct patch application
+      if (exists) {
+        if (result) {
+          it('patches the file correctly', () => {
+            assert.equal(read(filename), result)
+          })
+        } else {
+          it('does not modify the file', () => {
+            assert.equal(read(filename), originalContents)
+          })
+        }
+      // For non-existing files, verify creation and contents
+      } else {
+        if (result) {
+          it('creates the file', () => {
+            assert.isTrue(fs.existsSync(`${root}/${path}`))
+          })
+
+          it('writes the correct contents', () => {
+            assert.equal(read(filename), result)
+          })
+        } else {
+          it('does not create the file', () => {
+            assert.isFalse(fs.existsSync(`${root}/${path}`))
+          })
+        }
+      }
+    }
+  }
+})