Merge pull request #3 from Elhebert/ci/add-codecov

ci: add codecov

.asyncapi-tool

@@ -0,0 +1,12 @@
+{
+  "title": "AsyncAPI Validation",
+  "description": "Message validation package for YAML and JSON AsyncAPI documents.",
+  "links": {
+    "repoUrl": "https://github.com/Elhebert/asyncapi-validation"
+  },
+  "filters": {
+    "language": "TypeScript",
+    "technology": ["Node.js"],
+    "categories": ["validator"]
+  }
+}

.github/workflows/unit-test.yml

@@ -27,3 +27,7 @@ jobs:
           cache: 'pnpm'
       - run: pnpm install --frozen-lockfile
       - run: pnpm test
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 dist
+coverage

jest.config.js

@@ -2,4 +2,6 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
+  collectCoverage: true,
+  collectCoverageFrom: ['./src/**'],
 };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "asyncapi-validation",
   "version": "0.1.1",
-  "description": "AsyncAPI message validation",
+  "description": "Message validation package for YAML and JSON AsyncAPI documents.",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
   "files": [

tests/from-file.test.ts

@@ -154,4 +154,44 @@ describe('parsing `fromFile`', () => {
       expect((err as Error).message).toBe('data/lumens must be >= 0');
     }
   });
+
+  it('throw an error if the message key is not found for a 3.0.0 schema', async () => {
+    const validator = await asyncApiValidation.fromFile(
+      path.join(__dirname, 'fixtures', 'valid-schema-3.0.0.yaml')
+    );
+
+    const payload = {
+      lumens: 10,
+      sendAt: '2020-08-06T15:00:00+00:00',
+    };
+
+    try {
+      validator('wrong-key', payload);
+    } catch (err) {
+      expect(err).toBeInstanceOf(Error);
+      expect((err as Error).message).toBe(
+        'No messages found for the given key'
+      );
+    }
+  });
+
+  it('throw an error if the message key is not found for a 2.0.0 schema', async () => {
+    const validator = await asyncApiValidation.fromFile(
+      path.join(__dirname, 'fixtures', 'valid-schema-2.0.0.yaml')
+    );
+
+    const payload = {
+      lumens: 10,
+      sendAt: '2020-08-06T15:00:00+00:00',
+    };
+
+    try {
+      validator('wrong-key', payload);
+    } catch (err) {
+      expect(err).toBeInstanceOf(Error);
+      expect((err as Error).message).toBe(
+        'No messages found for the given key'
+      );
+    }
+  });
 });

tests/from-schema.test.ts

@@ -174,4 +174,48 @@ describe('parsing `fromSchema`', () => {
       expect((err as Error).message).toBe('data/lumens must be >= 0');
     }
   });
+
+  it('throw an error if the message key is not found for a 3.0.0 schema', async () => {
+    const schema = await readFile(
+      path.join(__dirname, 'fixtures', 'valid-schema-3.0.0.yaml'),
+      'utf-8'
+    );
+    const validator = await asyncApiValidation.fromSchema(schema);
+
+    const payload = {
+      lumens: 10,
+      sendAt: '2020-08-06T15:00:00+00:00',
+    };
+
+    try {
+      validator('wrong-key', payload);
+    } catch (err) {
+      expect(err).toBeInstanceOf(Error);
+      expect((err as Error).message).toBe(
+        'No messages found for the given key'
+      );
+    }
+  });
+
+  it('throw an error if the message key is not found for a 2.0.0 schema', async () => {
+    const schema = await readFile(
+      path.join(__dirname, 'fixtures', 'valid-schema-2.0.0.yaml'),
+      'utf-8'
+    );
+    const validator = await asyncApiValidation.fromSchema(schema);
+
+    const payload = {
+      lumens: 10,
+      sendAt: '2020-08-06T15:00:00+00:00',
+    };
+
+    try {
+      validator('wrong-key', payload);
+    } catch (err) {
+      expect(err).toBeInstanceOf(Error);
+      expect((err as Error).message).toBe(
+        'No messages found for the given key'
+      );
+    }
+  });
 });

tests/from-url.test.ts

@@ -94,4 +94,44 @@ describe('parsing `fromUrl`', () => {
       expect((err as Error).message).toBe('data/lumens must be >= 0');
     }
   });
+
+  it('throw an error if the message key is not found for a 3.0.0 schema', async () => {
+    const validator = await asyncApiValidation.fromUrl(
+      'https://raw.githubusercontent.com/asyncapi/spec/v3.0.0/examples/streetlights-kafka-asyncapi.yml'
+    );
+
+    const payload = {
+      lumens: 10,
+      sendAt: '2020-08-06T15:00:00+00:00',
+    };
+
+    try {
+      validator('wrong-key', payload);
+    } catch (err) {
+      expect(err).toBeInstanceOf(Error);
+      expect((err as Error).message).toBe(
+        'No messages found for the given key'
+      );
+    }
+  });
+
+  it('throw an error if the message key is not found for a 2.0.0 schema', async () => {
+    const validator = await asyncApiValidation.fromUrl(
+      'https://raw.githubusercontent.com/asyncapi/spec/v2.0.0/examples/2.0.0/streetlights.yml'
+    );
+
+    const payload = {
+      lumens: 10,
+      sendAt: '2020-08-06T15:00:00+00:00',
+    };
+
+    try {
+      validator('wrong-key', payload);
+    } catch (err) {
+      expect(err).toBeInstanceOf(Error);
+      expect((err as Error).message).toBe(
+        'No messages found for the given key'
+      );
+    }
+  });
 });