Write testcode

Author: owjs3901

packages/webpack-plugin/src/__tests__/index.test.ts

@@ -0,0 +1,9 @@
+import { expect, test } from 'bun:test'
+import * as indexModule from '../index'
+
+test('index.ts exports', () => {
+  expect({ ...indexModule }).toEqual({
+    devupApiWebpackPlugin: expect.any(Function),
+    default: expect.any(Function),
+  })
+})

packages/webpack-plugin/src/__tests__/plugin.test.ts

@@ -0,0 +1,263 @@
+import { beforeEach, expect, mock, spyOn, test } from 'bun:test'
+import { join } from 'node:path'
+import type { DevupApiOptions } from '@devup-api/core'
+import * as generator from '@devup-api/generator'
+import * as utils from '@devup-api/utils'
+import type { Compiler } from 'webpack'
+import { DefinePlugin } from 'webpack'
+import { devupApiWebpackPlugin } from '../plugin'
+
+let mockCreateTmpDirAsync: ReturnType<typeof spyOn>
+let mockReadOpenapiAsync: ReturnType<typeof spyOn>
+let mockWriteInterfaceAsync: ReturnType<typeof spyOn>
+let mockCreateUrlMap: ReturnType<typeof spyOn>
+let mockGenerateInterface: ReturnType<typeof spyOn>
+
+const mockSchema = {
+  openapi: '3.1.0',
+  paths: {
+    '/users': {
+      get: {
+        operationId: 'getUsers',
+        responses: {
+          '200': {
+            content: {
+              'application/json': {
+                schema: {
+                  type: 'array',
+                  items: { type: 'string' },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+} as const
+
+const mockUrlMap = {
+  getUsers: {
+    method: 'GET' as const,
+    url: '/users',
+  },
+  '/users': {
+    method: 'GET' as const,
+    url: '/users',
+  },
+}
+
+const mockInterfaceContent = 'export interface Test {}'
+
+const createMockCompiler = (): Compiler & {
+  _storedCallback?: (params: unknown, cb: (error?: Error) => void) => void
+} => {
+  const storedCallback: {
+    callback?: (params: unknown, cb: (error?: Error) => void) => void
+  } = {}
+  const tapAsyncMock = mock(
+    (
+      _name: string,
+      callback: (params: unknown, cb: (error?: Error) => void) => void,
+    ) => {
+      storedCallback.callback = callback
+    },
+  )
+  const hooks = {
+    beforeCompile: {
+      tapAsync: tapAsyncMock,
+    },
+  }
+  const compiler = {
+    hooks,
+  } as unknown as Compiler & {
+    _storedCallback?: (params: unknown, cb: (error?: Error) => void) => void
+  }
+  Object.defineProperty(compiler, '_storedCallback', {
+    get() {
+      return storedCallback.callback
+    },
+    enumerable: true,
+    configurable: true,
+  })
+  return compiler
+}
+
+beforeEach(() => {
+  mockCreateTmpDirAsync = spyOn(utils, 'createTmpDirAsync').mockResolvedValue(
+    'df',
+  )
+  mockReadOpenapiAsync = spyOn(utils, 'readOpenapiAsync').mockResolvedValue(
+    mockSchema as never,
+  )
+  mockWriteInterfaceAsync = spyOn(
+    utils,
+    'writeInterfaceAsync',
+  ).mockResolvedValue(undefined)
+  mockCreateUrlMap = spyOn(generator, 'createUrlMap').mockReturnValue(
+    mockUrlMap as never,
+  )
+  mockGenerateInterface = spyOn(generator, 'generateInterface').mockReturnValue(
+    mockInterfaceContent,
+  )
+  mockCreateTmpDirAsync.mockClear()
+  mockReadOpenapiAsync.mockClear()
+  mockWriteInterfaceAsync.mockClear()
+  mockCreateUrlMap.mockClear()
+  mockGenerateInterface.mockClear()
+})
+
+test('devupApiWebpackPlugin constructor initializes with default options', () => {
+  const plugin = new devupApiWebpackPlugin()
+  expect(plugin.options).toEqual({})
+  expect(plugin.initialized).toBe(false)
+})
+
+test.each([
+  [{ tempDir: 'custom-dir' }],
+  [{ openapiFile: 'custom-openapi.json' }],
+  [
+    {
+      tempDir: 'custom-dir',
+      openapiFile: 'custom-openapi.json',
+      convertCase: 'snake' as const,
+    },
+  ],
+] as const)('devupApiWebpackPlugin constructor initializes with options: %s', (options: DevupApiOptions) => {
+  const plugin = new devupApiWebpackPlugin(options)
+  expect(plugin.options).toEqual(options)
+  expect(plugin.initialized).toBe(false)
+})
+
+test('devupApiWebpackPlugin apply method registers beforeCompile hook', () => {
+  const plugin = new devupApiWebpackPlugin()
+  const compiler = createMockCompiler()
+  plugin.apply(compiler)
+  expect(compiler.hooks.beforeCompile.tapAsync).toHaveBeenCalledWith(
+    'devup-api',
+    expect.any(Function),
+  )
+  expect(compiler._storedCallback).toBeDefined()
+})
+
+test.each([
+  [undefined],
+  [{ tempDir: 'custom-dir' }],
+  [{ openapiFile: 'custom-openapi.json' }],
+  [
+    {
+      tempDir: 'custom-dir',
+      openapiFile: 'custom-openapi.json',
+      convertCase: 'pascal' as const,
+    },
+  ],
+] as const)('devupApiWebpackPlugin beforeCompile hook executes correctly: %s', async (options:
+  | DevupApiOptions
+  | undefined) => {
+  const plugin = new devupApiWebpackPlugin(options)
+  const compiler = createMockCompiler()
+  const definePluginApplySpy = spyOn(
+    DefinePlugin.prototype,
+    'apply',
+  ).mockImplementation(() => {})
+  plugin.apply(compiler)
+
+  const callback = compiler._storedCallback
+  expect(callback).toBeDefined()
+
+  const mockCallback = mock(() => {})
+  await callback?.(null, mockCallback)
+
+  expect(mockCreateTmpDirAsync).toHaveBeenCalledWith(options?.tempDir)
+  expect(mockReadOpenapiAsync).toHaveBeenCalledWith(options?.openapiFile)
+  expect(mockGenerateInterface).toHaveBeenCalledWith(mockSchema, options || {})
+  expect(mockWriteInterfaceAsync).toHaveBeenCalledWith(
+    join('df', 'api.d.ts'),
+    mockInterfaceContent,
+  )
+  expect(mockCreateUrlMap).toHaveBeenCalledWith(mockSchema, options || {})
+  expect(definePluginApplySpy).toHaveBeenCalledWith(compiler)
+  expect(mockCallback).toHaveBeenCalled()
+  expect(plugin.initialized).toBe(true)
+  definePluginApplySpy.mockRestore()
+})
+
+test('devupApiWebpackPlugin beforeCompile hook does not add DefinePlugin when urlMap is null', async () => {
+  mockCreateUrlMap.mockReturnValueOnce(null as never)
+  const plugin = new devupApiWebpackPlugin()
+  const compiler = createMockCompiler()
+  const definePluginApplySpy = spyOn(
+    DefinePlugin.prototype,
+    'apply',
+  ).mockImplementation(() => {})
+  plugin.apply(compiler)
+
+  const callback = compiler._storedCallback
+
+  const mockCallback = mock(() => {})
+  await callback?.(null, mockCallback)
+
+  expect(definePluginApplySpy).not.toHaveBeenCalled()
+  expect(mockCallback).toHaveBeenCalled()
+  definePluginApplySpy.mockRestore()
+})
+
+test('devupApiWebpackPlugin beforeCompile hook does not add DefinePlugin when urlMap is undefined', async () => {
+  mockCreateUrlMap.mockReturnValueOnce(undefined as never)
+  const plugin = new devupApiWebpackPlugin()
+  const compiler = createMockCompiler()
+  const definePluginApplySpy = spyOn(
+    DefinePlugin.prototype,
+    'apply',
+  ).mockImplementation(() => {})
+  plugin.apply(compiler)
+
+  const callback = compiler._storedCallback
+
+  const mockCallback = mock(() => {})
+  await callback?.(null, mockCallback)
+
+  expect(definePluginApplySpy).not.toHaveBeenCalled()
+  expect(mockCallback).toHaveBeenCalled()
+  definePluginApplySpy.mockRestore()
+})
+
+test('devupApiWebpackPlugin beforeCompile hook only runs once when called multiple times', async () => {
+  const plugin = new devupApiWebpackPlugin()
+  const compiler = createMockCompiler()
+  plugin.apply(compiler)
+
+  const callback = compiler._storedCallback
+
+  const mockCallback1 = mock(() => {})
+  const mockCallback2 = mock(() => {})
+
+  await Promise.all([
+    callback?.(null, mockCallback1),
+    callback?.(null, mockCallback2),
+  ])
+
+  expect(mockCreateTmpDirAsync).toHaveBeenCalledTimes(1)
+  expect(mockReadOpenapiAsync).toHaveBeenCalledTimes(1)
+  expect(mockGenerateInterface).toHaveBeenCalledTimes(1)
+  expect(mockWriteInterfaceAsync).toHaveBeenCalledTimes(1)
+  expect(mockCreateUrlMap).toHaveBeenCalledTimes(1)
+  expect(mockCallback1).toHaveBeenCalled()
+  expect(mockCallback2).toHaveBeenCalled()
+})
+
+test('devupApiWebpackPlugin beforeCompile hook handles errors correctly', async () => {
+  const error = new Error('Test error')
+  mockCreateTmpDirAsync.mockRejectedValueOnce(error)
+  const plugin = new devupApiWebpackPlugin()
+  const compiler = createMockCompiler()
+  plugin.apply(compiler)
+
+  const callback = compiler._storedCallback
+
+  const mockCallback = mock(() => {})
+  await callback?.(null, mockCallback)
+
+  expect(mockCallback).toHaveBeenCalledWith(error)
+  expect(plugin.initialized).toBe(false)
+})

packages/webpack-plugin/src/plugin.ts

@@ -11,7 +11,7 @@ import { DefinePlugin } from 'webpack'
 
 export class devupApiWebpackPlugin {
   options: DevupApiOptions
-  private initialized = false
+  initialized = false
 
   constructor(options?: DevupApiOptions) {
     this.options = options || {}