Skip to content

Minor refactoring of the db config store and tests #1924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
charisk merged 4 commits into from
Jan 4, 2023
Merged

Minor refactoring of the db config store and tests #1924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
943c85d
Remove unnecessary type castings
charisk Jan 4, 2023
651128c
Extract validation to separate functions
charisk Jan 4, 2023
ab956d3
Nest tests inside a 'describe' block
charisk Jan 4, 2023
48b20d2
Remove repeated code
charisk Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 26 additions & 18 deletions extensions/ql-vscode/src/databases/config/db-config-store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export class DbConfigStore extends DisposableObject {
);
}

const config: DbConfig = cloneDbConfig(this.config);
Comment thread
charisk marked this conversation as resolved.
const config = cloneDbConfig(this.config);
if (parentList) {
const parent = config.databases.remote.repositoryLists.find(
(list) => list.name === parentList,
Expand Down Expand Up @@ -123,7 +123,7 @@ export class DbConfigStore extends DisposableObject {
throw Error(`A remote owner with the name '${owner}' already exists`);
}

const config: DbConfig = cloneDbConfig(this.config);
const config = cloneDbConfig(this.config);
config.databases.remote.owners.push(owner);

await this.writeConfig(config);
Expand All @@ -134,15 +134,9 @@ export class DbConfigStore extends DisposableObject {
throw Error("Cannot add local list if config is not loaded");
}

if (listName === "") {
throw Error("List name cannot be empty");
}

if (this.doesLocalListExist(listName)) {
throw Error(`A local list with the name '${listName}' already exists`);
}
this.validateLocalListName(listName);

const config: DbConfig = cloneDbConfig(this.config);
const config = cloneDbConfig(this.config);
config.databases.local.lists.push({
name: listName,
databases: [],
Expand All @@ -156,15 +150,9 @@ export class DbConfigStore extends DisposableObject {
throw Error("Cannot add remote list if config is not loaded");
}

if (listName === "") {
throw Error("List name cannot be empty");
}

if (this.doesRemoteListExist(listName)) {
throw Error(`A remote list with the name '${listName}' already exists`);
}
this.validateRemoteListName(listName);

const config: DbConfig = cloneDbConfig(this.config);
const config = cloneDbConfig(this.config);
config.databases.remote.repositoryLists.push({
name: listName,
repositories: [],
Expand Down Expand Up @@ -336,4 +324,24 @@ export class DbConfigStore extends DisposableObject {
},
};
}

private validateLocalListName(listName: string): void {
if (listName === "") {
throw Error("List name cannot be empty");
}

if (this.doesLocalListExist(listName)) {
throw Error(`A local list with the name '${listName}' already exists`);
}
}

private validateRemoteListName(listName: string): void {
if (listName === "") {
throw Error("List name cannot be empty");
}

if (this.doesRemoteListExist(listName)) {
throw Error(`A remote list with the name '${listName}' already exists`);
}
}
}
262 changes: 133 additions & 129 deletions extensions/ql-vscode/test/unit-tests/databases/config/db-config-store.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,151 +16,155 @@ describe("db config store", () => {
await remove(tempWorkspaceStoragePath);
});

it("should create a new config if one does not exist", async () => {
const app = createMockApp({
extensionPath,
workspaceStoragePath: tempWorkspaceStoragePath,
describe("initialize", () => {
it("should create a new config if one does not exist", async () => {
const app = createMockApp({
extensionPath,
workspaceStoragePath: tempWorkspaceStoragePath,
});

const configPath = join(
tempWorkspaceStoragePath,
"workspace-databases.json",
);

const configStore = new DbConfigStore(app);
await configStore.initialize();

expect(await pathExists(configPath)).toBe(true);

const config = configStore.getConfig().value;
expect(config.databases.remote.repositoryLists).toHaveLength(0);
expect(config.databases.remote.owners).toHaveLength(0);
expect(config.databases.remote.repositories).toHaveLength(0);
expect(config.databases.local.lists).toHaveLength(0);
expect(config.databases.local.databases).toHaveLength(0);
expect(config.selected).toBeUndefined();

configStore.dispose();
});

const configPath = join(
tempWorkspaceStoragePath,
"workspace-databases.json",
);

const configStore = new DbConfigStore(app);
await configStore.initialize();

expect(await pathExists(configPath)).toBe(true);

const config = configStore.getConfig().value;
expect(config.databases.remote.repositoryLists).toHaveLength(0);
expect(config.databases.remote.owners).toHaveLength(0);
expect(config.databases.remote.repositories).toHaveLength(0);
expect(config.databases.local.lists).toHaveLength(0);
expect(config.databases.local.databases).toHaveLength(0);
expect(config.selected).toBeUndefined();

configStore.dispose();
});

it("should load an existing config", async () => {
const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePath,
});
const configStore = new DbConfigStore(app);
await configStore.initialize();

const config = configStore.getConfig().value;
expect(config.databases.remote.repositoryLists).toHaveLength(1);
expect(config.databases.remote.repositoryLists[0]).toEqual({
name: "repoList1",
repositories: ["foo/bar", "foo/baz"],
});
expect(config.databases.remote.owners).toHaveLength(0);
expect(config.databases.remote.repositories).toHaveLength(3);
expect(config.databases.remote.repositories).toEqual([
"owner/repo1",
"owner/repo2",
"owner/repo3",
]);
expect(config.databases.local.lists).toHaveLength(2);
expect(config.databases.local.lists[0]).toEqual({
name: "localList1",
databases: [
{
name: "foo/bar",
dateAdded: 1668096745193,
language: "go",
storagePath: "/path/to/database/",
},
],
});
expect(config.databases.local.databases).toHaveLength(1);
expect(config.databases.local.databases[0]).toEqual({
name: "example-db",
dateAdded: 1668096927267,
language: "ruby",
storagePath: "/path/to/database/",
});
expect(config.selected).toEqual({
kind: "remoteUserDefinedList",
listName: "repoList1",
it("should load an existing config", async () => {
const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePath,
});
const configStore = new DbConfigStore(app);
await configStore.initialize();

const config = configStore.getConfig().value;
expect(config.databases.remote.repositoryLists).toHaveLength(1);
expect(config.databases.remote.repositoryLists[0]).toEqual({
name: "repoList1",
repositories: ["foo/bar", "foo/baz"],
});
expect(config.databases.remote.owners).toHaveLength(0);
expect(config.databases.remote.repositories).toHaveLength(3);
expect(config.databases.remote.repositories).toEqual([
"owner/repo1",
"owner/repo2",
"owner/repo3",
]);
expect(config.databases.local.lists).toHaveLength(2);
expect(config.databases.local.lists[0]).toEqual({
name: "localList1",
databases: [
{
name: "foo/bar",
dateAdded: 1668096745193,
language: "go",
storagePath: "/path/to/database/",
},
],
});
expect(config.databases.local.databases).toHaveLength(1);
expect(config.databases.local.databases[0]).toEqual({
name: "example-db",
dateAdded: 1668096927267,
language: "ruby",
storagePath: "/path/to/database/",
});
expect(config.selected).toEqual({
kind: "remoteUserDefinedList",
listName: "repoList1",
});

configStore.dispose();
});

configStore.dispose();
});

it("should load an existing config without selected db", async () => {
const testDataStoragePathWithout = join(
__dirname,
"data",
"without-selected",
);
it("should load an existing config without selected db", async () => {
const testDataStoragePathWithout = join(
__dirname,
"data",
"without-selected",
);

const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePathWithout,
});
const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePathWithout,
});

const configStore = new DbConfigStore(app);
await configStore.initialize();
const configStore = new DbConfigStore(app);
await configStore.initialize();

const config = configStore.getConfig().value;
expect(config.selected).toBeUndefined();

configStore.dispose();
});
const config = configStore.getConfig().value;
expect(config.selected).toBeUndefined();

it("should not allow modification of the config", async () => {
const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePath,
configStore.dispose();
});
const configStore = new DbConfigStore(app);
await configStore.initialize();

const config = configStore.getConfig().value;
config.databases.remote.repositoryLists = [];
it("should not allow modification of the config", async () => {
const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePath,
});
const configStore = new DbConfigStore(app);
await configStore.initialize();

const reRetrievedConfig = configStore.getConfig().value;
expect(reRetrievedConfig.databases.remote.repositoryLists).toHaveLength(1);
const config = configStore.getConfig().value;
config.databases.remote.repositoryLists = [];

configStore.dispose();
});

it("should set codeQLDatabasesExperimental.configError to true when config has error", async () => {
const testDataStoragePathInvalid = join(__dirname, "data", "invalid");
const reRetrievedConfig = configStore.getConfig().value;
expect(reRetrievedConfig.databases.remote.repositoryLists).toHaveLength(
1,
);

const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePathInvalid,
configStore.dispose();
});
const configStore = new DbConfigStore(app);
await configStore.initialize();

expect(app.executeCommand).toBeCalledWith(
"setContext",
"codeQLDatabasesExperimental.configError",
true,
);
configStore.dispose();
});

it("should set codeQLDatabasesExperimental.configError to false when config is valid", async () => {
const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePath,
it("should set codeQLDatabasesExperimental.configError to true when config has error", async () => {
const testDataStoragePathInvalid = join(__dirname, "data", "invalid");

const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePathInvalid,
});
const configStore = new DbConfigStore(app);
await configStore.initialize();

expect(app.executeCommand).toBeCalledWith(
"setContext",
"codeQLDatabasesExperimental.configError",
true,
);
configStore.dispose();
});
const configStore = new DbConfigStore(app);
await configStore.initialize();

expect(app.executeCommand).toBeCalledWith(
"setContext",
"codeQLDatabasesExperimental.configError",
false,
);

configStore.dispose();
it("should set codeQLDatabasesExperimental.configError to false when config is valid", async () => {
const app = createMockApp({
extensionPath,
workspaceStoragePath: testDataStoragePath,
});
const configStore = new DbConfigStore(app);
await configStore.initialize();

expect(app.executeCommand).toBeCalledWith(
"setContext",
"codeQLDatabasesExperimental.configError",
false,
);

configStore.dispose();
});
});
});