Merge pull request #1853 from github/nora/test-factories-dbitem

Create and use more factories for DbItem creation

Author: norascheuch

extensions/ql-vscode/test/factories/db-item-factories.ts

@@ -1,34 +1,162 @@
+import { faker } from "@faker-js/faker";
 import {
   DbItemKind,
+  LocalDatabaseDbItem,
+  LocalDbItem,
+  LocalListDbItem,
+  RemoteDbItem,
+  RemoteOwnerDbItem,
+  RemoteRepoDbItem,
+  RemoteSystemDefinedListDbItem,
   RemoteUserDefinedListDbItem,
+  RootLocalDbItem,
   RootRemoteDbItem,
 } from "../../src/databases/db-item";
 
-export function createRootRemoteDbItem(): RootRemoteDbItem {
+// Root Remote Db Items
+export function createRootRemoteDbItem({
+  children = [],
+  expanded = false,
+}: {
+  children?: RemoteDbItem[];
+  expanded?: boolean;
+} = {}): RootRemoteDbItem {
   return {
     kind: DbItemKind.RootRemote,
-    children: [],
-    expanded: false,
+    children,
+    expanded,
+  };
+}
+
+export function createRemoteOwnerDbItem({
+  ownerName = `owner${faker.datatype.number()}`,
+  selected = false,
+}: {
+  ownerName?: string;
+  selected?: boolean;
+} = {}): RemoteOwnerDbItem {
+  return {
+    kind: DbItemKind.RemoteOwner,
+    selected,
+    ownerName,
+  };
+}
+
+export function createRemoteRepoDbItem({
+  repoFullName = `owner${faker.datatype.number()}/repo${faker.datatype.number}`,
+  selected = false,
+  parentListName = undefined,
+}: {
+  repoFullName?: string;
+  selected?: boolean;
+  parentListName?: string;
+} = {}): RemoteRepoDbItem {
+  return {
+    kind: DbItemKind.RemoteRepo,
+    selected,
+    repoFullName,
+    parentListName,
+  };
+}
+
+export function createRemoteSystemDefinedListDbItem({
+  listName = `top_${faker.datatype.number()}`,
+  listDisplayName = `Display Name`,
+  listDescription = `Description`,
+  selected = false,
+}: {
+  listName?: string;
+  listDisplayName?: string;
+  listDescription?: string;
+  selected?: boolean;
+} = {}): RemoteSystemDefinedListDbItem {
+  return {
+    kind: DbItemKind.RemoteSystemDefinedList,
+    selected,
+    listName,
+    listDisplayName,
+    listDescription,
   };
 }
 
 export function createRemoteUserDefinedListDbItem({
-  name = "list1",
+  expanded = false,
+  selected = false,
+  listName = `list${faker.datatype.number()}`,
+  repos = [
+    createRemoteRepoDbItem({
+      parentListName: listName,
+    }),
+  ],
 }: {
-  name: string;
-}): RemoteUserDefinedListDbItem {
+  listName?: string;
+  expanded?: boolean;
+  selected?: boolean;
+  repos?: RemoteRepoDbItem[];
+} = {}): RemoteUserDefinedListDbItem {
   return {
     kind: DbItemKind.RemoteUserDefinedList,
-    selected: false,
-    expanded: false,
-    listName: name,
-    repos: [
-      {
-        kind: DbItemKind.RemoteRepo,
-        selected: false,
-        repoFullName: "repo1",
-        parentListName: name,
-      },
-    ],
+    expanded,
+    selected,
+    listName,
+    repos,
+  };
+}
+
+// Root Local Db Items
+export function createRootLocalDbItem({
+  children = [],
+  expanded = false,
+}: {
+  children?: LocalDbItem[];
+  expanded?: boolean;
+} = {}): RootLocalDbItem {
+  return {
+    kind: DbItemKind.RootLocal,
+    children,
+    expanded,
+  };
+}
+
+export function createLocalDatabaseDbItem({
+  databaseName = `database${faker.datatype.number()}`,
+  dateAdded = faker.date.past().getTime(),
+  language = `language${faker.datatype.number()}`,
+  storagePath = `storagePath${faker.datatype.number()}`,
+  selected = false,
+}: {
+  databaseName?: string;
+  dateAdded?: number;
+  language?: string;
+  storagePath?: string;
+  selected?: boolean;
+} = {}): LocalDatabaseDbItem {
+  return {
+    kind: DbItemKind.LocalDatabase,
+    selected,
+    databaseName,
+    dateAdded,
+    language,
+    storagePath,
+  };
+}
+
+export function createLocalListDbItem({
+  listName = `top_${faker.datatype.number()}`,
+  selected = false,
+  expanded = false,
+  databases = [],
+}: {
+  listName?: string;
+  databases?: LocalDatabaseDbItem[];
+  selected?: boolean;
+  expanded?: boolean;
+} = {}): LocalListDbItem {
+  return {
+    kind: DbItemKind.LocalList,
+    selected,
+    expanded,
+    databases,
+    listName,
   };
 }

extensions/ql-vscode/test/pure-tests/databases/db-item-expansion.test.ts

@@ -26,7 +26,7 @@ describe("db item expansion", () => {
 
     const dbItem: RemoteUserDefinedListDbItem =
       createRemoteUserDefinedListDbItem({
-        name: "list2",
+        listName: "list2",
       });
 
     const newExpandedItems = calculateNewExpandedState(
@@ -47,7 +47,7 @@ describe("db item expansion", () => {
   it("should add an expanded item to an empty list", () => {
     const dbItem: RemoteUserDefinedListDbItem =
       createRemoteUserDefinedListDbItem({
-        name: "list2",
+        listName: "list2",
       });
 
     const newExpandedItems = calculateNewExpandedState([], dbItem, true);
@@ -73,7 +73,7 @@ describe("db item expansion", () => {
 
     const dbItem: RemoteUserDefinedListDbItem =
       createRemoteUserDefinedListDbItem({
-        name: "list1",
+        listName: "list1",
       });
 
     const newExpandedItems = calculateNewExpandedState(