chore: Refactor test-utils tests (#78)

just-boris · web-flow · commit 44c8c9c0aa1d · 2025-07-17T16:08:13.000Z
diff --git a/fixtures/test-utils/advanced-types/index.ts b/fixtures/test-utils/advanced-types/index.ts
diff --git a/fixtures/test-utils/advanced-types/tsconfig.json b/fixtures/test-utils/advanced-types/tsconfig.json
@@ -1,4 +1,3 @@
 {
-  "extends": "../tsconfig.json",
-  "include": ["advanced-types.ts"]
+  "extends": "../tsconfig.json"
 }
diff --git a/fixtures/test-utils/default-values/index.ts b/fixtures/test-utils/default-values/index.ts
@@ -0,0 +1,9 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export class DefaultValueWrapper {
+  selectOption(index = 1): void {}
+
+  openDropdown(expandToViewport = false): void {}
+
+  getColumns(order: 'first' | 'last' = 'first'): void {}
+}
diff --git a/fixtures/test-utils/default-values/tsconfig.json b/fixtures/test-utils/default-values/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../tsconfig.json"
+}
diff --git a/fixtures/test-utils/inheritance/index.ts b/fixtures/test-utils/inheritance/index.ts
diff --git a/fixtures/test-utils/inheritance/tsconfig.json b/fixtures/test-utils/inheritance/tsconfig.json
@@ -1,4 +1,3 @@
 {
-  "extends": "../tsconfig.json",
-  "include": ["inheritance.ts"]
+  "extends": "../tsconfig.json"
 }
diff --git a/fixtures/test-utils/simple/index.ts b/fixtures/test-utils/simple/index.ts
diff --git a/fixtures/test-utils/simple/tsconfig.json b/fixtures/test-utils/simple/tsconfig.json
@@ -1,4 +1,3 @@
 {
   "extends": "../tsconfig.json",
-  "include": ["simple.ts"]
 }
diff --git a/src/bootstrap/typescript.ts b/src/bootstrap/typescript.ts
@@ -22,6 +22,7 @@ function loadTSConfig(tsconfigPath: string): ts.ParsedCommandLine {
   }
   const config = ts.parseJsonConfigFileContent(configFile.config, ts.sys, pathe.dirname(tsconfigPath));
   if (config.errors.length > 0) {
+    console.error(...config.errors);
     throw new Error('Failed to parse tsconfig.json');
   }
   // this prints a warning that incremental mode is not supported in programmatic API
diff --git a/src/test-utils/interfaces.ts b/src/test-utils/interfaces.ts
@@ -1,6 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-
 export interface Parameter {
   name: string;
   typeName?: string;
@@ -19,8 +18,8 @@ export interface TestUtilMethod {
   description?: string;
   returnType?: {
     name: string;
-    type: string;
-    typeArguments: Array<TypeArgument>;
+    type?: string;
+    typeArguments?: Array<TypeArgument>;
   };
   parameters: Array<Parameter>;
   inheritedFrom?: {
diff --git a/test/components/test-helpers.ts b/test/components/test-helpers.ts
@@ -6,9 +6,7 @@ import pathe from 'pathe';
 import ts from 'typescript';
 import { ProjectReflection } from 'typedoc';
 import { documentComponents } from '../../src/components';
-import { documentTestUtils } from '../../src/test-utils';
 import { bootstrapProject } from '../../src/bootstrap';
-import { TestUtilsDoc } from '../../src/test-utils/interfaces';
 import { DocumenterOptions } from '../../src/components';
 
 export function buildProject(name: string, options?: Partial<DocumenterOptions>) {
@@ -23,15 +21,6 @@ export function getTemporaryDir() {
   return fs.mkdtempSync(pathe.join(os.tmpdir(), 'documenter-'));
 }
 
-export function buildTestUtilsProject(name: string, testGlob?: string): TestUtilsDoc[] {
-  return documentTestUtils(
-    {
-      tsconfig: require.resolve(`../../fixtures/test-utils/${name}/tsconfig.json`),
-    },
-    testGlob || `fixtures/test-utils/${name}/**/*`
-  );
-}
-
 export function buildCustomProject(tsConfig: string, testGlob: string): ProjectReflection {
   const project = bootstrapProject(
     {
diff --git a/test/test-utils/doc-generation.test.ts b/test/test-utils/doc-generation.test.ts
@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { describe, expect, test } from 'vitest';
-import { buildTestUtilsProject } from '../components/test-helpers';
+import { buildTestUtilsProject } from './test-helpers';
 
 describe('Generate documentation', () => {
   test('For simple cases', () => {
@@ -25,7 +25,7 @@ describe('Generate documentation', () => {
     expect(noOpMethod?.inheritedFrom).toBeUndefined();
 
     const findStringMethod = methods.find(method => method.name === 'findString');
-    expect(findStringMethod).toBeDefined;
+    expect(findStringMethod).toBeDefined();
     expect(findStringMethod?.returnType).toEqual({ name: 'string', type: 'intrinsic' });
     expect(findStringMethod?.parameters).toEqual([]);
     expect(findStringMethod?.description).toBe(
@@ -34,22 +34,20 @@ describe('Generate documentation', () => {
     expect(findStringMethod?.inheritedFrom).toBeUndefined();
 
     const setStringMethod = methods.find(method => method.name === 'setString');
-    expect(setStringMethod).toBeDefined;
+    expect(setStringMethod).toBeDefined();
     expect(setStringMethod?.returnType).toEqual({ name: 'void', type: 'intrinsic' });
     expect(setStringMethod?.parameters).toMatchSnapshot();
     expect(setStringMethod?.description).toBe('Short Text');
     expect(setStringMethod?.inheritedFrom).toBeUndefined();
 
     const findObjectMethod = methods.find(method => method.name === 'findObject');
-    expect(findObjectMethod).toBeDefined;
+    expect(findObjectMethod).toBeDefined();
     expect(findObjectMethod?.returnType).toEqual({ name: 'TestReturnType', type: 'reference' });
     expect(findObjectMethod?.parameters).toEqual([]);
     expect(findObjectMethod?.description).toBe('Short Text.\nLong Text.\n');
     expect(findObjectMethod?.inheritedFrom).toBeUndefined();
   });
 
-  // TODO: Testing here could me more exhaustive, but we do testing for types in different tests already.
-  // Try to reuse existing type extraction utils in another step. Adjust testing accordingly.
   test('deal with more complex types', () => {
     const results = buildTestUtilsProject('advanced-types');
 
@@ -62,7 +60,7 @@ describe('Generate documentation', () => {
     expect(methods.length).toBe(2);
 
     const findAllMethod = methods.find(method => method.name === 'findAll');
-    expect(findAllMethod).toBeDefined;
+    expect(findAllMethod).toBeDefined();
     expect(findAllMethod?.returnType).toEqual({
       name: 'Array',
       type: 'reference',
@@ -78,7 +76,7 @@ describe('Generate documentation', () => {
     expect(findAllMethod?.inheritedFrom).toBeUndefined();
 
     const setAllMethod = methods.find(method => method.name === 'setAll');
-    expect(setAllMethod).toBeDefined;
+    expect(setAllMethod).toBeDefined();
     expect(setAllMethod?.returnType).toEqual({
       name: 'void',
       type: 'intrinsic',
@@ -100,13 +98,59 @@ describe('Generate documentation', () => {
     expect(methods.length).toBe(2);
 
     const inheritedMethod = methods.find(method => method.name === 'inheritedMethod');
-    expect(inheritedMethod).toBeDefined;
+    expect(inheritedMethod).toBeDefined();
     expect(inheritedMethod?.inheritedFrom).toEqual({
       name: 'AbstractWrapper.inheritedMethod',
     });
 
     const childClassMethod = methods.find(method => method.name === 'childClassMethod');
-    expect(childClassMethod).toBeDefined;
+    expect(childClassMethod).toBeDefined();
     expect(childClassMethod?.inheritedFrom).toBeUndefined();
   });
+
+  test('default value rendering', () => {
+    const results = buildTestUtilsProject('default-values');
+    expect(results.length).toBe(1);
+
+    const classDoc = results.find(classDoc => classDoc.name === 'DefaultValueWrapper');
+    expect(classDoc).toBeDefined();
+
+    expect(classDoc!.methods).toEqual([
+      {
+        name: 'getColumns',
+        parameters: [
+          {
+            name: 'order',
+            flags: { isOptional: false },
+            defaultValue: '"first"',
+          },
+        ],
+        returnType: { name: 'void', type: 'intrinsic' },
+      },
+      {
+        name: 'openDropdown',
+        parameters: [
+          {
+            name: 'expandToViewport',
+            typeName: 'boolean',
+            flags: { isOptional: false },
+            defaultValue: 'false',
+          },
+        ],
+        returnType: { name: 'void', type: 'intrinsic' },
+      },
+      {
+        name: 'selectOption',
+        parameters: [
+          {
+            name: 'index',
+            typeName: 'number',
+            flags: { isOptional: false },
+            defaultValue: '1',
+          },
+        ],
+        returnType: { name: 'void', type: 'intrinsic' },
+      },
+    ]);
+  });
 });
diff --git a/test/test-utils/test-helpers.ts b/test/test-utils/test-helpers.ts
@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { documentTestUtils } from '../../src/test-utils';
+import { TestUtilsDoc } from '../../src/test-utils/interfaces';
+
+export function buildTestUtilsProject(name: string, testGlob?: string): TestUtilsDoc[] {
+  return documentTestUtils(
+    {
+      tsconfig: require.resolve(`../../fixtures/test-utils/${name}/tsconfig.json`),
+    },
+    testGlob || `fixtures/test-utils/${name}/**/*`
+  );
+}
diff --git a/test/test-utils/usage.test.ts b/test/test-utils/usage.test.ts
@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { describe, expect, test } from 'vitest';
-import { buildTestUtilsProject } from '../components/test-helpers';
+import { buildTestUtilsProject } from './test-helpers';
 
 describe('documentTestUtils throws error for ', () => {
   test('failing project generation because of invalid config', () => {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`	`1`	`{`
`2`		`- "extends": "../tsconfig.json",`
`3`		`- "include": ["advanced-types.ts"]`
	`2`	`+ "extends": "../tsconfig.json"`
`4`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "extends": "../tsconfig.json"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`	`1`	`{`
`2`		`- "extends": "../tsconfig.json",`
`3`		`- "include": ["inheritance.ts"]`
	`2`	`+ "extends": "../tsconfig.json"`
`4`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "../tsconfig.json",`
`3`		`- "include": ["simple.ts"]`
`4`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ function loadTSConfig(tsconfigPath: string): ts.ParsedCommandLine {`
`22`	`22`	`}`
`23`	`23`	`const config = ts.parseJsonConfigFileContent(configFile.config, ts.sys, pathe.dirname(tsconfigPath));`
`24`	`24`	`if (config.errors.length > 0) {`
	`25`	`+ console.error(...config.errors);`
`25`	`26`	`throw new Error('Failed to parse tsconfig.json');`
`26`	`27`	`}`
`27`	`28`	`// this prints a warning that incremental mode is not supported in programmatic API`