test: create rules tests

Author: araujogui

src/linter/tests/fixtures/entries.mjs

@@ -0,0 +1,84 @@
+/**
+ * Noop function.
+ *
+ * @returns {any}
+ */
+const noop = () => {};
+
+/**
+ * @type {ApiDocMetadataEntry}
+ */
+export const assertEntry = {
+  api: 'assert',
+  slug: 'assert',
+  source_link: 'lib/assert.js',
+  api_doc_source: 'doc/api/assert.md',
+  added_in: undefined,
+  deprecated_in: undefined,
+  removed_in: undefined,
+  n_api_version: undefined,
+  changes: [
+    {
+      version: 'v9.9.0',
+      'pr-url': 'https://github.com/nodejs/node/pull/17615',
+      description: 'Added error diffs to the strict assertion mode.',
+    },
+    {
+      version: 'v9.9.0',
+      'pr-url': 'https://github.com/nodejs/node/pull/17002',
+      description: 'Added strict assertion mode to the assert module.',
+    },
+    {
+      version: ['v13.9.0', 'v12.16.2'],
+      'pr-url': 'https://github.com/nodejs/node/pull/31635',
+      description:
+        'Changed "strict mode" to "strict assertion mode" and "legacy mode" to "legacy assertion mode" to avoid confusion with the more usual meaning of "strict mode".',
+    },
+    {
+      version: 'v15.0.0',
+      'pr-url': 'https://github.com/nodejs/node/pull/34001',
+      description: "Exposed as `require('node:assert/strict')`.",
+    },
+  ],
+  heading: {
+    type: 'heading',
+    depth: 1,
+    children: [
+      {
+        type: 'text',
+        value: 'Assert',
+        position: {
+          start: { line: 1, column: 3, offset: 2 },
+          end: { line: 1, column: 9, offset: 8 },
+        },
+      },
+    ],
+    position: {
+      start: { line: 1, column: 1, offset: 0 },
+      end: { line: 1, column: 9, offset: 8 },
+    },
+    data: {
+      text: 'Assert',
+      name: 'Assert',
+      depth: 1,
+      slug: 'assert',
+      type: 'property',
+    },
+    toJSON: noop,
+  },
+  stability: {
+    type: 'root',
+    children: [],
+    toJSON: noop,
+  },
+  content: {
+    type: 'root',
+    children: [],
+  },
+  tags: [],
+  introduced_in: 'v0.1.21',
+  yaml_position: {
+    start: { line: 7, column: 1, offset: 103 },
+    end: { line: 7, column: 35, offset: 137 },
+  },
+};

src/linter/tests/rules/invalid-change-version.test.mjs

@@ -0,0 +1,41 @@
+import { describe, it } from 'node:test';
+import { invalidChangeVersion } from '../../rules/invalid-change-version.mjs';
+import { deepEqual } from 'node:assert';
+import { assertEntry } from '../fixtures/entries.mjs';
+
+describe('invalidChangeVersion', () => {
+  it('should return an empty array if all change versions are valid', () => {
+    const issues = invalidChangeVersion(assertEntry);
+
+    deepEqual(issues, []);
+  });
+
+  it('should return an issue if a change version is invalid', () => {
+    const issues = invalidChangeVersion({
+      ...assertEntry,
+      changes: [...assertEntry.changes, { version: ['v13.9.0', 'REPLACEME'] }],
+    });
+
+    deepEqual(issues, [
+      {
+        level: 'warn',
+        location: {
+          path: 'doc/api/assert.md',
+          position: {
+            end: {
+              column: 35,
+              line: 7,
+              offset: 137,
+            },
+            start: {
+              column: 1,
+              line: 7,
+              offset: 103,
+            },
+          },
+        },
+        message: 'Invalid version number: REPLACEME',
+      },
+    ]);
+  });
+});

src/linter/tests/rules/missing-change-version.test.mjs

@@ -0,0 +1,31 @@
+import { describe, it } from 'node:test';
+import { deepEqual } from 'node:assert';
+import { missingChangeVersion } from '../../rules/missing-change-version.mjs';
+import { assertEntry } from '../fixtures/entries.mjs';
+
+describe('missingChangeVersion', () => {
+  it('should return an empty array if all change versions are non-empty', () => {
+    const issues = missingChangeVersion(assertEntry);
+
+    deepEqual(issues, []);
+  });
+
+  it('should return an issue if a change version is missing', () => {
+    const issues = missingChangeVersion({
+      ...assertEntry,
+      changes: [...assertEntry.changes, { version: undefined }],
+    });
+
+    deepEqual(issues, [
+      {
+        level: 'warn',
+        location: {
+          column: 1,
+          line: 7,
+          path: 'doc/api/assert.md',
+        },
+        message: 'Missing change version',
+      },
+    ]);
+  });
+});

src/linter/tests/rules/missing-introduced-in.test.mjs

@@ -0,0 +1,38 @@
+import { describe, it } from 'node:test';
+import { missingIntroducedIn } from '../../rules/missing-introduced-in.mjs';
+import { deepEqual } from 'assert';
+import { assertEntry } from '../fixtures/entries.mjs';
+
+describe('missingIntroducedIn', () => {
+  it('should return an empty array if the introduced_in field is not missing', () => {
+    const issues = missingIntroducedIn(assertEntry);
+
+    deepEqual(issues, []);
+  });
+
+  it('should return an empty array if the heading depth is not equal to 1', () => {
+    const issues = missingIntroducedIn({
+      ...assertEntry,
+      heading: { ...assertEntry.heading, depth: 2 },
+    });
+
+    deepEqual(issues, []);
+  });
+
+  it('should return an issue if the introduced_in property is missing', () => {
+    const issues = missingIntroducedIn({
+      ...assertEntry,
+      introduced_in: undefined,
+    });
+
+    deepEqual(issues, [
+      {
+        level: 'info',
+        location: {
+          path: 'doc/api/assert.md',
+        },
+        message: "Missing 'introduced_in' field in the API doc entry",
+      },
+    ]);
+  });
+});