zenstack 0.1.42 → 1.0.0

package/tests/integration/package.json

@@ -0,0 +1,27 @@
+{
+    "name": "integration",
+    "version": "1.0.0",
+    "description": "",
+    "main": "index.js",
+    "scripts": {
+        "test": "jest --runInBand"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "devDependencies": {
+        "@types/jest": "^29.0.3",
+        "@types/supertest": "^2.0.12",
+        "@types/tmp": "^0.2.3",
+        "jest": "^29.0.3",
+        "next": "^12.3.1",
+        "supertest": "^6.3.0",
+        "tmp": "^0.2.1",
+        "ts-jest": "^29.0.1",
+        "ts-node": "^10.9.1",
+        "typescript": "^4.6.2"
+    },
+    "dependencies": {
+        "@types/node": "^14.18.29"
+    }
+}

package/tests/integration/tests/operation-coverate.test.ts

@@ -0,0 +1,563 @@
+import path from 'path';
+import { makeClient, run, setup } from './utils';
+
+describe('Operation Coverage Tests', () => {
+    let workDir: string;
+    let origDir: string;
+
+    beforeAll(async () => {
+        origDir = path.resolve('.');
+        workDir = await setup('./tests/operations.zmodel');
+    });
+
+    beforeEach(() => {
+        run('npx prisma migrate reset --schema ./zenstack/schema.prisma -f');
+    });
+
+    afterAll(() => {
+        process.chdir(origDir);
+    });
+
+    //#region Empty Policy
+
+    it('empty policy', async () => {
+        const client = makeClient('/api/data/EmptyPolicy');
+        await client.post('/').send({ data: {} }).expect(403);
+        await client
+            .get('/')
+            .expect((resp) => expect(resp.body).toHaveLength(0));
+    });
+
+    it('nested write empty policy to-many', async () => {
+        const client = makeClient('/api/data/M1');
+        await client
+            .post('/')
+            .send({
+                data: {
+                    m2: {
+                        create: [{}],
+                    },
+                },
+            })
+            .expect(403);
+    });
+
+    it('nested write empty policy to-one', async () => {
+        const client = makeClient('/api/data/M1');
+        await client
+            .post('/')
+            .send({
+                data: {
+                    m3: {
+                        create: {},
+                    },
+                },
+            })
+            .expect(403);
+    });
+
+    //#endregion
+
+    //#region Toplevel operations
+
+    it('toplevel find and get', async () => {
+        await makeClient('/api/data/M4')
+            .post('/')
+            .send({
+                data: {
+                    id: '1',
+                    value: 1,
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M4')
+            .get('/')
+            .expect((resp) => expect(resp.body).toHaveLength(0));
+
+        await makeClient('/api/data/M4/1').get('/').expect(404);
+
+        await makeClient('/api/data/M4')
+            .post('/')
+            .send({
+                data: {
+                    id: '2',
+                    value: 2,
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M4')
+            .get('/')
+            .expect((resp) => expect(resp.body).toHaveLength(1));
+
+        await makeClient('/api/data/M4/2').get('/').expect(200);
+    });
+
+    it('toplevel create, update and delete', async () => {
+        await makeClient('/api/data/M4')
+            .post('/')
+            .send({
+                data: {
+                    value: 0,
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M4')
+            .post('/')
+            .send({
+                data: {
+                    id: '1',
+                    value: 1,
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M4/1')
+            .put('/')
+            .send({
+                data: {
+                    value: 1,
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M4')
+            .post('/')
+            .send({
+                data: {
+                    id: '2',
+                    value: 2,
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M4/2')
+            .put('/')
+            .send({
+                data: {
+                    value: 3,
+                },
+            })
+            .expect(200);
+
+        await makeClient('/api/data/M4/1').delete('/').expect(403);
+        await makeClient('/api/data/M4/2').delete('/').expect(200);
+    });
+
+    //#endregion
+
+    //#region Nested To-one
+
+    it('nested to-one writes', async () => {
+        await makeClient('/api/data/M5')
+            .post('/')
+            .send({
+                data: {
+                    m6: {
+                        create: {
+                            value: 0,
+                        },
+                    },
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M5')
+            .post('/')
+            .send({
+                data: {
+                    id: '1',
+                    m6: {
+                        create: {
+                            id: '1',
+                            value: 1,
+                        },
+                    },
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                data: {
+                    m6: {
+                        update: {
+                            value: 2,
+                        },
+                    },
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M5')
+            .post('/')
+            .send({
+                data: {
+                    id: '2',
+                    m6: {
+                        create: {
+                            id: '2',
+                            value: 2,
+                        },
+                    },
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M5/2')
+            .put('/')
+            .send({
+                data: {
+                    id: '2',
+                    m6: {
+                        delete: true,
+                    },
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M5/2')
+            .put('/')
+            .send({
+                data: {
+                    m6: {
+                        update: {
+                            value: 3,
+                        },
+                    },
+                },
+            })
+            .expect(200);
+
+        await makeClient('/api/data/M6/2').get('/').expect(200);
+
+        await makeClient('/api/data/M5/2')
+            .put('/')
+            .send({
+                data: {
+                    id: '2',
+                    m6: {
+                        delete: true,
+                    },
+                },
+            })
+            .expect(200);
+
+        await makeClient('/api/data/M6/2').get('/').expect(404);
+    });
+
+    //#endregion
+
+    //#region Nested To-many
+
+    it('nested to-many create denied', async () => {
+        const client = makeClient('/api/data/M5');
+
+        // single-create
+        await client
+            .post('/')
+            .send({
+                data: {
+                    m7: {
+                        create: {
+                            value: 0,
+                        },
+                    },
+                },
+            })
+            .expect(403);
+
+        // multi-create
+        await client
+            .post('/')
+            .send({
+                data: {
+                    m7: {
+                        create: [
+                            {
+                                value: 0,
+                            },
+                            {
+                                value: 1,
+                            },
+                        ],
+                    },
+                },
+            })
+            .expect(403);
+    });
+
+    it('nested to-many create allowed', async () => {
+        const client = makeClient('/api/data/M5');
+
+        // single-create
+        await client
+            .post('/')
+            .send({
+                data: {
+                    m7: {
+                        create: {
+                            value: 1,
+                        },
+                    },
+                },
+            })
+            .expect(201);
+
+        // multi-create
+        await client
+            .post('/')
+            .send({
+                data: {
+                    m7: {
+                        create: [
+                            {
+                                value: 1,
+                            },
+                            {
+                                value: 2,
+                            },
+                        ],
+                    },
+                },
+            })
+            .expect(201);
+    });
+
+    it('nested to-many update', async () => {
+        // nested entities don't satisify policy before update, so should be excluded
+        await makeClient('/api/data/M5')
+            .post('/')
+            .send({
+                data: {
+                    id: '1',
+                    m7: {
+                        create: [
+                            {
+                                id: '1',
+                                value: 1,
+                            },
+                        ],
+                    },
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                include: { m7: true },
+                data: {
+                    m7: {
+                        update: {
+                            where: { id: '1' },
+                            data: { value: 2 },
+                        },
+                    },
+                },
+            })
+            .expect(200)
+            .expect((resp) => {
+                expect(resp.body.m7).toEqual(
+                    expect.arrayContaining([
+                        expect.objectContaining({ id: '1', value: 1 }),
+                    ])
+                );
+            });
+
+        // nested entities satisify policy before update, so should be included for update
+        await makeClient('/api/data/M5')
+            .post('/')
+            .send({
+                data: {
+                    id: '2',
+                    m7: {
+                        create: {
+                            id: '2',
+                            value: 2,
+                        },
+                    },
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M5/2')
+            .put('/')
+            .send({
+                include: { m7: true },
+                data: {
+                    m7: {
+                        update: {
+                            where: { id: '2' },
+                            data: { value: 3 },
+                        },
+                    },
+                },
+            })
+            .expect(200)
+            .expect((resp) => {
+                expect(resp.body.m7).toEqual(
+                    expect.arrayContaining([
+                        expect.objectContaining({ id: '2', value: 3 }),
+                    ])
+                );
+            });
+    });
+
+    it('nested to-many update with create', async () => {
+        await makeClient('/api/data/M5')
+            .post('/')
+            .send({
+                data: {
+                    id: '1',
+                    m7: {
+                        create: {
+                            value: 1,
+                        },
+                    },
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                data: {
+                    m7: {
+                        create: {
+                            id: '2',
+                            value: 0,
+                        },
+                    },
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                data: {
+                    m7: {
+                        create: [
+                            {
+                                value: 0,
+                            },
+                            {
+                                value: 1,
+                            },
+                        ],
+                    },
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                include: { m7: true },
+                data: {
+                    m7: {
+                        create: [
+                            {
+                                value: 1,
+                            },
+                            {
+                                value: 2,
+                            },
+                        ],
+                    },
+                },
+            })
+            .expect(200)
+            .expect((resp) => {
+                expect(resp.body.m7).toHaveLength(3);
+            });
+    });
+
+    it('nested to-many update with delete', async () => {
+        await makeClient('/api/data/M5')
+            .post('/')
+            .send({
+                data: {
+                    id: '1',
+                    m7: {
+                        create: [
+                            {
+                                id: '1',
+                                value: 1,
+                            },
+                            {
+                                id: '2',
+                                value: 2,
+                            },
+                            {
+                                id: '3',
+                                value: 3,
+                            },
+                            {
+                                id: '4',
+                                value: 4,
+                            },
+                            {
+                                id: '5',
+                                value: 5,
+                            },
+                        ],
+                    },
+                },
+            })
+            .expect(201);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                data: {
+                    m7: {
+                        delete: { id: '1' },
+                    },
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                data: {
+                    m7: {
+                        deleteMany: { OR: [{ id: '2' }, { id: '3' }] },
+                    },
+                },
+            })
+            .expect(403);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                data: {
+                    m7: {
+                        delete: { id: '3' },
+                    },
+                },
+            })
+            .expect(200);
+        await makeClient('/api/data/M7/3').get('/').expect(404);
+
+        await makeClient('/api/data/M5/1')
+            .put('/')
+            .send({
+                data: {
+                    m7: {
+                        deleteMany: { value: { gte: 4 } },
+                    },
+                },
+            })
+            .expect(200);
+        await makeClient('/api/data/M7/4').get('/').expect(404);
+        await makeClient('/api/data/M7/5').get('/').expect(404);
+    });
+
+    //#endregion
+});

package/tests/integration/tests/operations.zmodel

@@ -0,0 +1,69 @@
+datasource db {
+    provider = 'sqlite'
+    url = 'file:./operations.db'
+}
+
+model EmptyPolicy {
+    id String @id @default(uuid())
+}
+
+model M1 {
+    id String @id @default(uuid())
+    m2 M2[]
+    m3 M3?
+
+    @@allow('all', true)
+}
+
+model M2 {
+    id String @id @default(uuid())
+    m1 M1 @relation(fields: [m1Id], references:[id])
+    m1Id String
+}
+
+model M3 {
+    id String @id @default(uuid())
+    m1 M1 @relation(fields: [m1Id], references:[id])
+    m1Id String @unique
+}
+
+model M4 {
+    id String @id @default(uuid())
+    value Int
+
+    @@allow('read', value > 1)
+    @@allow('create', value > 0)
+    @@allow('update', value > 1)
+    @@allow('delete', value > 2)
+}
+
+model M5 {
+    id String @id @default(uuid())
+    m6 M6?
+    m7 M7[]
+
+    @@allow('all', true)
+}
+
+model M6 {
+    id String @id @default(uuid())
+    value Int
+    m5 M5 @relation(fields: [m5Id], references:[id])
+    m5Id String @unique
+
+    @@allow('read', true)
+    @@allow('create', value > 0)
+    @@allow('update', value > 1)
+    @@allow('delete', value > 2)
+}
+
+model M7 {
+    id String @id @default(uuid())
+    value Int
+    m5 M5 @relation(fields: [m5Id], references:[id])
+    m5Id String
+
+    @@allow('create', value > 0)
+    @@allow('update', value > 1)
+    @@allow('delete', value > 2)
+}