From 006b3e8effa2ef123fd07ad0e04d895b3d2e04c4 Mon Sep 17 00:00:00 2001
From: Camila Belo <camilaibs@gmail.com>
Date: Tue, 11 Jun 2024 13:50:39 +0200
Subject: [PATCH] refactor(test-utils): rename MockDirectoryOptions to
 CreateMockDirectoryOptions

Signed-off-by: Camila Belo <camilaibs@gmail.com>
---
 .changeset/honest-badgers-ring.md             |  5 ++++
 packages/backend-test-utils/api-report.md     | 15 +++++++-----
 packages/backend-test-utils/src/deprecated.ts | 23 +++++++++++++++++++
 .../src/filesystem/MockDirectory.ts           |  4 ++--
 .../src/filesystem/index.ts                   |  2 +-
 packages/backend-test-utils/src/index.ts      |  1 +
 6 files changed, 41 insertions(+), 9 deletions(-)
 create mode 100644 .changeset/honest-badgers-ring.md
 create mode 100644 packages/backend-test-utils/src/deprecated.ts

diff --git a/.changeset/honest-badgers-ring.md b/.changeset/honest-badgers-ring.md
new file mode 100644
index 0000000000..c1e763e6cb
--- /dev/null
+++ b/.changeset/honest-badgers-ring.md
@@ -0,0 +1,5 @@
+---
+'@backstage/backend-test-utils': patch
+---
+
+The type `MockDirectoryOptions` was renamed to `CreateMockDirectoryOptions` so that it's clear these options are exclusive to the mock directory factory.
diff --git a/packages/backend-test-utils/api-report.md b/packages/backend-test-utils/api-report.md
index f3d790ebfe..cc30dc8f56 100644
--- a/packages/backend-test-utils/api-report.md
+++ b/packages/backend-test-utils/api-report.md
@@ -45,9 +45,15 @@ import { UserInfoService } from '@backstage/backend-plugin-api';
 
 // @public
 export function createMockDirectory(
-  options?: MockDirectoryOptions,
+  options?: CreateMockDirectoryOptions,
 ): MockDirectory;
 
+// @public
+export interface CreateMockDirectoryOptions {
+  content?: MockDirectoryContent;
+  mockOsTmpDir?: boolean;
+}
+
 // @public (undocumented)
 export function isDockerDisabledForTests(): boolean;
 
@@ -136,11 +142,8 @@ export interface MockDirectoryContentOptions {
   shouldReadAsText?: boolean | ((path: string, buffer: Buffer) => boolean);
 }
 
-// @public
-export interface MockDirectoryOptions {
-  content?: MockDirectoryContent;
-  mockOsTmpDir?: boolean;
-}
+// @public @deprecated (undocumented)
+export type MockDirectoryOptions = CreateMockDirectoryOptions;
 
 // @public (undocumented)
 export namespace mockServices {
diff --git a/packages/backend-test-utils/src/deprecated.ts b/packages/backend-test-utils/src/deprecated.ts
new file mode 100644
index 0000000000..fad7523367
--- /dev/null
+++ b/packages/backend-test-utils/src/deprecated.ts
@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { CreateMockDirectoryOptions } from './filesystem';
+
+/**
+ * @public
+ * @deprecated Use `CreateMockDirectoryOptions` from `@backstage/backend-test-utils` instead.
+ */
+export type MockDirectoryOptions = CreateMockDirectoryOptions;
diff --git a/packages/backend-test-utils/src/filesystem/MockDirectory.ts b/packages/backend-test-utils/src/filesystem/MockDirectory.ts
index 1c10c77fc6..39518f5d9c 100644
--- a/packages/backend-test-utils/src/filesystem/MockDirectory.ts
+++ b/packages/backend-test-utils/src/filesystem/MockDirectory.ts
@@ -347,7 +347,7 @@ class MockDirectoryImpl {
  *
  * @public
  */
-export interface MockDirectoryOptions {
+export interface CreateMockDirectoryOptions {
   /**
    * In addition to creating a temporary directory, also mock `os.tmpdir()` to return the
    * mock directory path until the end of the test suite.
@@ -386,7 +386,7 @@ export interface MockDirectoryOptions {
  * ```
  */
 export function createMockDirectory(
-  options?: MockDirectoryOptions,
+  options?: CreateMockDirectoryOptions,
 ): MockDirectory {
   const tmpDir = process.env.RUNNER_TEMP || os.tmpdir(); // GitHub Actions
   const root = fs.mkdtempSync(joinPath(tmpDir, 'backstage-tmp-test-dir-'));
diff --git a/packages/backend-test-utils/src/filesystem/index.ts b/packages/backend-test-utils/src/filesystem/index.ts
index e18b0b55b8..4a045c153d 100644
--- a/packages/backend-test-utils/src/filesystem/index.ts
+++ b/packages/backend-test-utils/src/filesystem/index.ts
@@ -16,8 +16,8 @@
 
 export {
   createMockDirectory,
+  type CreateMockDirectoryOptions,
   type MockDirectory,
-  type MockDirectoryOptions,
   type MockDirectoryContent,
   type MockDirectoryContentOptions,
   type MockDirectoryContentCallback,
diff --git a/packages/backend-test-utils/src/index.ts b/packages/backend-test-utils/src/index.ts
index 72abd908c5..a9feacbacd 100644
--- a/packages/backend-test-utils/src/index.ts
+++ b/packages/backend-test-utils/src/index.ts
@@ -20,6 +20,7 @@
  * @packageDocumentation
  */
 
+export * from './deprecated';
 export * from './cache';
 export * from './database';
 export * from './msw';