test: add tests for Readme component

Author: batchu5

packages/components/test/components/Readme.test.js

@@ -0,0 +1,142 @@
+import path from 'path';
+import { render } from '@asyncapi/generator-react-sdk';
+import { Parser, fromFile } from '@asyncapi/parser';
+import { buildParams } from '@asyncapi/generator-helpers';
+import { Readme } from '../../src/components/readme/Readme';
+
+const parser = new Parser();
+const asyncapi_websocket_query = path.resolve(__dirname, '../__fixtures__/asyncapi-v3.yml');
+
+describe('Testing of Readme component', () => {
+  let parsedAsyncAPIDocument;
+  let params;
+
+  const languages = ['javascript', 'python'];
+
+  beforeAll(async () => {
+    const parseResult = await fromFile(parser, asyncapi_websocket_query).parse();
+    parsedAsyncAPIDocument = parseResult.document;
+
+    params = buildParams(
+      'javascript',
+      { clientFileName: 'myClient.js' },
+      'production'
+    );
+  });
+
+  languages.forEach((language) => {
+    test(`render Readme with language = ${language}`, () => {
+      const result = render(
+        <Readme
+          asyncapi={parsedAsyncAPIDocument}
+          params={params}
+          language={language}
+        />
+      );
+
+      const actual = result.trim();
+      expect(actual).toMatchSnapshot();
+    });
+  });
+
+  test('render Readme component when asyncapi is missing', () => {
+    const renderReadme = () =>
+      render(
+        <Readme
+          params={params}
+          language="javascript"
+        />
+      );
+
+    expect(renderReadme).toThrow(TypeError);
+  });
+
+  test('render Readme component when params are missing', () => {
+    const renderReadme = () =>
+      render(
+        <Readme
+          asyncapi={parsedAsyncAPIDocument}
+          language="javascript"
+        />
+      );
+
+    expect(renderReadme).toThrow(TypeError);
+  });
+
+  test('render Readme component when language is missing', () => {
+    const renderReadme = () =>
+      render(
+        <Readme
+          asyncapi={parsedAsyncAPIDocument}
+          params={params}
+        />
+      );
+
+    expect(renderReadme).toThrow(TypeError);
+  });
+
+  test('render Readme with unsupported language', () => {
+    const renderReadme = () =>
+      render(
+        <Readme
+          asyncapi={parsedAsyncAPIDocument}
+          params={params}
+          language='dart'
+        />
+      );
+
+    expect(renderReadme).toThrow(TypeError);
+  });
+
+  test('render Readme when asyncapi is explicitly null', () => {
+    const renderReadme = () =>
+      render(
+        <Readme
+          asyncapi={null}
+          params={params}
+          language="javascript"
+        />
+      );
+
+    expect(renderReadme).toThrow(TypeError);
+  });
+
+  test('render Readme when params is explicitly null', () => {
+    const renderReadme = () =>
+      render(
+        <Readme
+          asyncapi={parsedAsyncAPIDocument}
+          params={null}
+          language="javascript"
+        />
+      );
+
+    expect(renderReadme).toThrow(TypeError);
+  });
+
+  test('render Readme when language is explicitly null', () => {
+    const renderReadme = () =>
+      render(
+        <Readme
+          asyncapi={parsedAsyncAPIDocument}
+          params={params}
+          language={null}
+        />
+      );
+
+    expect(renderReadme).toThrow(TypeError);
+  });
+
+  test('render Readme with empty string language', () => {
+    const renderReadme = () =>
+      render(
+        <Readme
+          asyncapi={parsedAsyncAPIDocument}
+          params={params}
+          language={''}
+        />
+      );
+
+    expect(renderReadme).toThrow(TypeError);
+  });
+});

packages/components/test/components/__snapshots__/Readme.test.js.snap

@@ -0,0 +1,115 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing of Readme component render Readme with language = javascript 1`] = `
+"# Account Service
+
+## Overview
+
+This service is in charge of processing user signups
+
+- **Version:** 1.0.0
+- **Server URL:** ws://api.example.com
+
+
+## Installation
+
+Install dependencies:
+
+\`\`\`bash
+npm install
+\`\`\`
+
+
+## Usage
+
+\`\`\`javascript
+const AccountService = require('./myClient');
+const wsClient = new AccountService();
+
+async function main() {
+  try {
+    await wsClient.connect();
+    // use wsClient to send/receive messages
+    await wsClient.close();
+  } catch (error) {
+    console.error('Failed to connect:', error);
+  }
+}
+
+main();
+\`\`\`
+
+
+## API
+
+### \`connect()\`
+Establishes a WebSocket connection.
+
+### \`registerMessageHandler(handlerFunction)\`
+Registers a callback for incoming messages.
+
+### \`registerErrorHandler(handlerFunction)\`
+Registers a callback for connection errors.
+
+### \`close()\`
+Closes the WebSocket connection.
+
+
+### Available Operations
+
+#### \`sendUserSignedup(payload)\`"
+`;
+
+exports[`Testing of Readme component render Readme with language = python 1`] = `
+"# Account Service
+
+## Overview
+
+This service is in charge of processing user signups
+
+- **Version:** 1.0.0
+- **Server URL:** ws://api.example.com
+
+
+## Installation
+
+Install dependencies:
+
+\`\`\`bash
+pip install -r requirements.txt
+\`\`\`
+
+
+## Usage
+
+\`\`\`python
+from myClient.js import AccountService
+
+ws_client = AccountService()
+
+async def main():
+    await ws_client.connect()
+    # use ws_client to send/receive messages
+    await ws_client.close()
+\`\`\`
+
+
+## API
+
+### \`connect()\`
+Establishes a WebSocket connection.
+
+### \`register_message_handler(handler_function)\`
+Registers a callback for incoming messages.
+
+### \`register_error_handler(handler_function)\`
+Registers a callback for connection errors.
+
+### \`close()\`
+Closes the WebSocket connection.
+
+
+### Available Operations
+
+#### \`sendUserSignedup(payload)\`"
+`;