Unit Tests - Node

src/SDK/Language/Node.php

@@ -2,7 +2,7 @@
 
 namespace Appwrite\SDK\Language;
 
-class Node extends Web
+class Node extends JS
 {
     /**
      * @return string
@@ -145,21 +145,41 @@ public function getFiles(): array
                 'destination'   => 'src/models.ts',
                 'template'      => 'web/src/models.ts.twig',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'test/permission.test.js',
+                'template'      => 'node/test/permission.test.js.twig',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'src/permission.ts',
                 'template'      => 'web/src/permission.ts.twig',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'test/role.test.js',
+                'template'      => 'node/test/role.test.js.twig',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'src/role.ts',
                 'template'      => 'web/src/role.ts.twig',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'test/id.test.js',
+                'template'      => 'node/test/id.test.js.twig',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'src/id.ts',
                 'template'      => 'web/src/id.ts.twig',
             ],
+            [
+                'scope'         => 'default',
+                'destination'   => 'test/query.test.js',
+                'template'      => 'node/test/query.test.js.twig',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'src/query.ts',
@@ -170,6 +190,11 @@ public function getFiles(): array
                 'destination'   => 'src/operator.ts',
                 'template'      => 'node/src/operator.ts.twig',
             ],
+            [
+                'scope'         => 'service',
+                'destination'   => '/test/services/{{service.name | caseDash}}.test.js',
+                'template'      => 'node/test/services/service.test.js.twig',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'README.md',

templates/node/package.json.twig

@@ -46,7 +46,8 @@
     "tsup": "7.2.0",
     "esbuild-plugin-file-path-extensions": "^2.0.0",
     "tslib": "2.6.2",
-    "typescript": "5.4.2"
+    "typescript": "5.4.2",
+    "jest": "^29.7.0"
   },
   "dependencies": {
     "json-bigint": "1.0.0",

templates/node/test/id.test.js.twig

@@ -0,0 +1,6 @@
+const ID = require("../lib/id");
+
+describe("ID", () => {
+    test('unique', () => expect(ID.unique()).toEqual('unique()'));
+    test('custom', () => expect(ID.custom('custom')).toEqual('custom'));
+});

templates/node/test/permission.test.js.twig

@@ -0,0 +1,10 @@
+const Permission = require("../lib/permission");
+const Role = require("../lib/role");
+
+describe('Permission', () => {
+    test('read', () => expect(Permission.read(Role.any())).toEqual('read("any")'));
+    test('write', () => expect(Permission.write(Role.any())).toEqual('write("any")'));
+    test('create', () => expect(Permission.create(Role.any())).toEqual('create("any")'));
+    test('update', () => expect(Permission.update(Role.any())).toEqual('update("any")'));
+    test('delete', () => expect(Permission.delete(Role.any())).toEqual('delete("any")'));
+})

templates/node/test/query.test.js.twig

@@ -0,0 +1,155 @@
+const Query = require("../lib/query");
+
+const tests = [
+    {
+        description: 'with a string',
+        value: 's',
+        expectedValues: '["s"]'
+    },
+    {
+        description: 'with a integer',
+        value: 1,
+        expectedValues: '[1]'
+    },
+    {
+        description: 'with a double',
+        value: 1.2,
+        expectedValues: '[1.2]'
+    },
+    {
+        description: 'with a whole number double',
+        value: 1.0,
+        expectedValues: '[1]'
+    },
+    {
+        description: 'with a bool',
+        value: false,
+        expectedValues: '[false]'
+    },
+    {
+        description: 'with a list',
+        value: ['a', 'b', 'c'],
+        expectedValues: '["a","b","c"]'
+    }
+];
+
+describe('Query', () => {
+    describe('basic filter equal', () => {
+        for (const t of tests) {
+            test(t.description, () =>
+                expect(Query.equal("attr", t.value))
+                    .toEqual(`equal("attr", ${t.expectedValues})`)
+            )
+        }
+    })
+
+    describe('basic filter notEqual', () => {
+        for (const t of tests) {
+            test(t.description, () =>
+                expect(Query.notEqual("attr", t.value))
+                    .toEqual(`notEqual("attr", ${t.expectedValues})`)
+            )
+        }
+    });
+
+    describe('basic filter lessThan', () => {
+        for (const t of tests) {
+            test(t.description, () =>
+                expect(Query.lessThan("attr", t.value))
+                    .toEqual(`lessThan("attr", ${t.expectedValues})`)
+            )
+        }
+    });
+
+    describe('basic filter lessThanEqual', () => {
+        for (const t of tests) {
+            test(t.description, () =>
+                expect(Query.lessThanEqual("attr", t.value))
+                    .toEqual(`lessThanEqual("attr", ${t.expectedValues})`)
+            )
+        }
+    });
+
+    describe('basic filter greaterThan', () => {
+        for (const t of tests) {
+            test(t.description, () =>
+                expect(Query.greaterThan("attr", t.value))
+                    .toEqual(`greaterThan("attr", ${t.expectedValues})`)
+            )
+        }
+    });
+
+    describe('basic filter greaterThanEqual', () => {
+        for (const t of tests) {
+            test(t.description, () =>
+                expect(Query.greaterThanEqual("attr", t.value))
+                    .toEqual(`greaterThanEqual("attr", ${t.expectedValues})`)
+            )
+        }
+    });
+
+    test('search', () =>
+        expect(Query.search('attr', 'keyword1 keyword2'))
+            .toEqual('search("attr", ["keyword1 keyword2"])')
+    );
+
+    test('isNull', () =>
+        expect(Query.isNull('attr'))
+            .toEqual('isNull("attr")')
+    );
+
+    test('isNotNull', () =>
+        expect(Query.isNotNull('attr'))
+            .toEqual('isNotNull("attr")')
+    );
+
+    describe('between', () => {
+        test('with integers', () =>
+            expect(Query.between('attr', 1, 2))
+                .toEqual('between("attr", 1, 2)')
+        );
+        test('with doubles', () =>
+            expect(Query.between('attr', 1.2, 2.2))
+                .toEqual('between("attr", 1.2, 2.2)')
+        );
+        test('with strings', () =>
+            expect(Query.between('attr', "a", "z"))
+                .toEqual('between("attr", "a" "z")')
+        );
+    });
+
+    test('select', () =>
+        expect(Query.select(['attr1', 'attr2']))
+            .toEqual('select(["attr1","attr2"])')
+    );
+
+    test('orderAsc', () =>
+        expect(Query.orderAsc('attr'))
+            .toEqual('orderAsc("attr")')
+    );
+
+    test('orderDesc', () =>
+        expect(Query.orderDesc('attr'))
+            .toEqual('orderDesc("attr")')
+    );
+
+    test('cursorBefore', () =>
+        expect(Query.cursorBefore('attr'))
+            .toEqual('cursorBefore("attr")')
+    );
+
+    test('cursorAfter', () =>
+        expect(Query.cursorAfter('attr'))
+            .toEqual('cursorAfter("attr")')
+    );
+
+    test('limit', () =>
+        expect(Query.limit(1))
+            .toEqual('limit(1)')
+    );
+
+    test('offset', () =>
+        expect(Query.offset(1))
+            .toEqual('offset(1)')
+    );
+})

templates/node/test/role.test.js.twig

@@ -0,0 +1,14 @@
+const Role = require("../lib/role");
+
+describe('Role', () => {
+    test('any', () => expect(Role.any()).toEqual('any'));
+    test('user without status', () => expect(Role.user('custom')).toEqual('user:custom'));
+    test('user with status', () => expect(Role.user('custom', 'verified')).toEqual('user:custom/verified'));
+    test('users without status', () => expect(Role.users()).toEqual('users'));
+    test('users with status', () => expect(Role.users('verified')).toEqual('users/verified'));
+    test('guests', () => expect(Role.guests()).toEqual('guests'));
+    test('team without role', () => expect(Role.team('custom')).toEqual('team:custom'))
+    test('team with role', () => expect(Role.team('custom', 'owner')).toEqual('team:custom/owner'))
+    test('member', () => expect(Role.member('custom')).toEqual('member:custom'))
+    test('label', () => expect(Role.label('admin')).toEqual('label:admin'))
+})

templates/node/test/services/service.test.js.twig

@@ -0,0 +1,38 @@
+const Client = require("../../lib/client");
+const InputFile = require("../../lib/inputFile");
+const {{ service.name | caseUcfirst }} = require("../../lib/services/{{ service.name | caseCamel }}");
+
+const mockedAxios = require("axios");
+jest.mock('axios', () => jest.fn());
+
+describe('{{ service.name | caseUcfirst }}', () => {
+    const client = new Client();
+    const {{ service.name | caseCamel }} = new {{ service.name | caseUcfirst }}(client);
+
+    {% for method in service.methods ~%}
+    test('test method {{ method.name | caseCamel }}()', async () => {
+        {%~ if method.type == 'webAuth' %}
+        const data = '';
+        {%~ elseif method.type == 'location' %}
+        const data = new Uint8Array(0);
+        {%~ else %}
+        {%- if method.responseModel and method.responseModel != 'any' %}
+        const data = {
+            {%- for definition in spec.definitions ~%}{%~ if definition.name == method.responseModel -%}{%~ for property in definition.properties | filter((param) => param.required) ~%}
+            '{{ property.name | escapeDollarSign }}': {% if property.type == 'object' %}{}{% elseif property.type == 'array' %}[]{% elseif property.type == 'string' %}'{{ property.example | escapeDollarSign }}'{% elseif property.type == 'boolean' %}true{% else %}{{ property.example }}{% endif %},{%~ endfor ~%}{% set break = true %}{%- else -%}{% set continue = true %}{%- endif -%}{%~ endfor -%}
+        };
+        {%~ else %}
+        const data = '';
+        {%~ endif %}
+        {%~ endif %}
+
+        mockedAxios.mockImplementation(() => Promise.resolve({data: data}));
+
+        const response = await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({%~ for parameter in method.parameters.all | filter((param) => param.required) ~%}
+            {% if parameter.type == 'object' %}{}{% elseif parameter.type == 'array' %}[]{% elseif parameter.type == 'file' %}InputFile.fromBuffer(new Uint8Array(0), 'image.png'){% elseif parameter.type == 'boolean' %}true{% elseif parameter.type == 'string' %}'{% if parameter.example is not empty %}{{ parameter.example | escapeDollarSign }}{% endif %}'{% elseif parameter.type == 'integer' and parameter['x-example'] is empty %}1{% elseif parameter.type == 'number' and parameter['x-example'] is empty %}1.0{% else %}{{ parameter.example }}{%~ endif ~%},{%~ endfor ~%}
+        );
+
+        expect(response).toEqual(data);
+    });
+    {% endfor %}
+})