test(terraform-module): add terraform-module tests

- Adds full coverage for the terraform-module component
- Refactor shared types into `/src/types`
- Add one additional function into `/utils/string`

Author: virgofx

__tests__/_setup.ts

@@ -7,6 +7,11 @@ vi.mock('@actions/core');
 vi.mock('@/config');
 vi.mock('@/context');
 
+
+// Mock console time/timeEnd to be a no-op
+vi.spyOn(console, 'time').mockImplementation(() => {});
+vi.spyOn(console, 'timeEnd').mockImplementation(() => {});
+
 const defaultEnvironmentVariables = {
   GITHUB_EVENT_NAME: 'pull_request',
   GITHUB_REPOSITORY: 'techpivot/terraform-module-releaser',

__tests__/changelog.test.ts

@@ -1,13 +1,13 @@
 import { getModuleChangelog, getModuleReleaseChangelog, getPullRequestChangelog } from '@/changelog';
 import { context } from '@/mocks/context';
-import type { TerraformChangedModule, TerraformModule } from '@/terraform-module';
+import type { TerraformChangedModule, TerraformModule } from '@/types';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
 describe('changelog', () => {
   const mockDate = new Date('2024-11-05');
 
   beforeEach(() => {
-    vi.useFakeTimers();
+    //vi.useFakeTimers();
     vi.setSystemTime(mockDate);
 
     // Reset context mock before each test

__tests__/config.test.ts

@@ -1,9 +1,8 @@
 import { clearConfigForTesting, config, getConfig } from '@/config';
+import { booleanConfigKeys, booleanInputs, requiredInputs, stubInputEnv } from '@/tests/helpers/inputs';
 import { endGroup, getBooleanInput, getInput, info, startGroup } from '@actions/core';
 import { beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';
 
-import { booleanConfigKeys, booleanInputs, requiredInputs, stubInputEnv } from '@/tests/helpers/inputs';
-
 describe('config', () => {
   beforeAll(() => {
     // We globally mock context to facilitate majority of testing; however,

__tests__/helpers/inputs.ts

@@ -1,4 +1,4 @@
-import type { Config } from '@/config';
+import type { Config } from '@/types';
 import { vi } from 'vitest';
 
 const INPUT_KEY = 'INPUT_';

__tests__/index.test.ts

@@ -0,0 +1,12 @@
+import * as main from '@/main';
+import { describe, expect, it, vi } from 'vitest';
+
+// Mock the main module's run function
+vi.spyOn(main, 'run').mockImplementation(async () => {});
+
+describe('index', () => {
+  it('calls run when imported', async () => {
+    await import('@/index');
+    expect(main.run).toHaveBeenCalled();
+  });
+});

__tests__/pull-request.test.ts

@@ -1,9 +1,8 @@
 import { config } from '@/mocks/config';
 import { context } from '@/mocks/context';
 import { addPostReleaseComment, addReleasePlanComment, getPullRequestCommits, hasReleaseComment } from '@/pull-request';
-import type { GitHubRelease } from '@/releases';
-import type { TerraformChangedModule } from '@/terraform-module';
 import { stubOctokitImplementation, stubOctokitReturnData } from '@/tests/helpers/octokit';
+import type { GitHubRelease, TerraformChangedModule } from '@/types';
 import { BRANDING_COMMENT, GITHUB_ACTIONS_BOT_USER_ID, PR_RELEASE_MARKER, PR_SUMMARY_MARKER } from '@/utils/constants';
 import { WikiStatus } from '@/wiki';
 import { debug, endGroup, info, startGroup } from '@actions/core';

__tests__/releases.test.ts

@@ -1,9 +1,8 @@
 import { config } from '@/mocks/config';
 import { context } from '@/mocks/context';
 import { createTaggedRelease, deleteLegacyReleases, getAllReleases } from '@/releases';
-import type { GitHubRelease } from '@/releases';
-import type { TerraformChangedModule } from '@/terraform-module';
 import { stubOctokitReturnData } from '@/tests/helpers/octokit';
+import type { GitHubRelease, TerraformChangedModule } from '@/types';
 import { debug, endGroup, info, startGroup } from '@actions/core';
 import { RequestError } from '@octokit/request-error';
 import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from 'vitest';

__tests__/terraform-docs.test.ts

@@ -5,7 +5,7 @@ import { join } from 'node:path';
 import { promisify } from 'node:util';
 import { context } from '@/mocks/context';
 import { ensureTerraformDocsConfigDoesNotExist, generateTerraformDocs, installTerraformDocs } from '@/terraform-docs';
-import type { TerraformModule } from '@/terraform-module';
+import type { TerraformModule } from '@/types';
 import { info } from '@actions/core';
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import which from 'which';