Skip to content

Convert connectionStore.test.ts from TypeMoq to Sinon #19709

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

Closed
wants to merge 5 commits into from
Closed

Convert connectionStore.test.ts from TypeMoq to Sinon #19709

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
faba42b
Initial plan
Copilot Jul 7, 2025
3ecab5a
Convert connectionStore.test.ts from TypeMoq to Sinon - basic conversion
Copilot Jul 7, 2025
90cc808
Convert connectionStore.test.ts from TypeMoq to Sinon - complete conv…
Copilot Jul 7, 2025
2ea5da2
Clean up backup file from connectionStore.test.ts conversion
Copilot Jul 7, 2025
14ed174
Changes before error encountered
Copilot Jul 7, 2025
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
219 changes: 120 additions & 99 deletions test/unit/connectionStore.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,99 +1,120 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import * as TypeMoq from "typemoq";
import * as vscode from "vscode";
import { ConnectionStore } from "../../src/models/connectionStore";
import { ICredentialStore } from "../../src/credentialstore/icredentialstore";
import { Logger } from "../../src/models/logger";
import { ConnectionConfig } from "../../src/connectionconfig/connectionconfig";
import VscodeWrapper from "../../src/controllers/vscodeWrapper";
import { expect } from "chai";
import * as sinon from "sinon";

suite("ConnectionStore Tests", () => {
let sandbox: sinon.SinonSandbox;
let connectionStore: ConnectionStore;

let mockContext: TypeMoq.IMock<vscode.ExtensionContext>;
let mockLogger: TypeMoq.IMock<Logger>;
let mockCredentialStore: TypeMoq.IMock<ICredentialStore>;
let mockConnectionConfig: TypeMoq.IMock<ConnectionConfig>;
let mockVscodeWrapper: TypeMoq.IMock<VscodeWrapper>;

setup(async () => {
sandbox = sinon.createSandbox();

mockContext = TypeMoq.Mock.ofType<vscode.ExtensionContext>();
mockVscodeWrapper = TypeMoq.Mock.ofType<VscodeWrapper>();
mockLogger = TypeMoq.Mock.ofType<Logger>();
mockCredentialStore = TypeMoq.Mock.ofType<ICredentialStore>();
mockConnectionConfig = TypeMoq.Mock.ofType<ConnectionConfig>();

mockConnectionConfig
.setup((c) => c.getConnections(TypeMoq.It.isAny()))
.returns(() => {
return Promise.resolve([]);
});
});

teardown(() => {
sandbox.restore();
});

test("Initializes correctly", async () => {
expect(() => {
connectionStore = new ConnectionStore(
mockContext.object,
mockCredentialStore.object,
mockLogger.object,
mockConnectionConfig.object,
mockVscodeWrapper.object,
);
}).to.not.throw();

await connectionStore.initialized; // Wait for initialization to complete
});

test("formatCredentialId", () => {
const testServer = "localhost";
const testDatabase = "TestDb";
const testUser = "testUser";

let credentialId = ConnectionStore.formatCredentialId(
testServer,
testDatabase,
testUser,
ConnectionStore.CRED_MRU_USER,
false, // isConnectionString
);

expect(credentialId).to.equal(
"Microsoft.SqlTools|itemtype:Mru|server:localhost|db:TestDb|user:testUser",
);

credentialId = ConnectionStore.formatCredentialId(
testServer,
testDatabase,
testUser,
undefined, // itemType
true, // isConnectionString
);

expect(credentialId).to.equal(
"Microsoft.SqlTools|itemtype:Profile|server:localhost|db:TestDb|user:testUser|isConnectionString:true",
);

credentialId = ConnectionStore.formatCredentialId(testServer, testDatabase);

expect(credentialId).to.equal(
"Microsoft.SqlTools|itemtype:Profile|server:localhost|db:TestDb",
);

credentialId = ConnectionStore.formatCredentialId(testServer);

expect(credentialId).to.equal("Microsoft.SqlTools|itemtype:Profile|server:localhost");
});
});
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import * as vscode from "vscode";
import { ConnectionStore } from "../../src/models/connectionStore";
import { ICredentialStore } from "../../src/credentialstore/icredentialstore";
import { Logger } from "../../src/models/logger";
import { ConnectionConfig } from "../../src/connectionconfig/connectionconfig";
import VscodeWrapper from "../../src/controllers/vscodeWrapper";
import { expect } from "chai";
import * as sinon from "sinon";

suite("ConnectionStore Tests", () => {
let sandbox: sinon.SinonSandbox;
let connectionStore: ConnectionStore;

let mockContext: sinon.SinonStubbedInstance<vscode.ExtensionContext>;
let mockLogger: sinon.SinonStubbedInstance<Logger>;
let mockCredentialStore: sinon.SinonStubbedInstance<ICredentialStore>;
let mockConnectionConfig: sinon.SinonStubbedInstance<ConnectionConfig>;
let mockVscodeWrapper: sinon.SinonStubbedInstance<VscodeWrapper>;

setup(async () => {
sandbox = sinon.createSandbox();

// Create stub for vscode.ExtensionContext (interface)
mockContext = {} as sinon.SinonStubbedInstance<vscode.ExtensionContext>;

// Create stub instances for classes
mockVscodeWrapper = sandbox.createStubInstance(VscodeWrapper);
mockLogger = sandbox.createStubInstance(Logger);
mockConnectionConfig = sandbox.createStubInstance(ConnectionConfig);

// Create stub for ICredentialStore (interface)
mockCredentialStore = {} as sinon.SinonStubbedInstance<ICredentialStore>;

// Set up the getConnections method to return an empty array
mockConnectionConfig.getConnections.resolves([]);

// Set up the initialized property to return a resolved promise
const resolvedDeferred = {
promise: Promise.resolve(),
resolve: () => {},
reject: () => {},
then: (onfulfilled?: () => void) => {
if (onfulfilled) {
onfulfilled();
}
return Promise.resolve();
},
};

Check failure on line 54 in test/unit/connectionStore.test.ts

View workflow job for this annotation

GitHub Actions / build-and-test 

Delete `········`
// Use Object.defineProperty to define the initialized property on the mock instance
Object.defineProperty(mockConnectionConfig, 'initialized', {

Check failure on line 56 in test/unit/connectionStore.test.ts

View workflow job for this annotation

GitHub Actions / build-and-test 

Replace `'initialized'` with `"initialized"`
get: () => resolvedDeferred,
enumerable: true,
configurable: true

Check failure on line 59 in test/unit/connectionStore.test.ts

View workflow job for this annotation

GitHub Actions / build-and-test 

Insert `,`
});
});

teardown(() => {
sandbox.restore();
});

test("Initializes correctly", async () => {
expect(() => {
connectionStore = new ConnectionStore(
mockContext,
mockCredentialStore,
mockLogger,
mockConnectionConfig,
mockVscodeWrapper,
);
}).to.not.throw();

await connectionStore.initialized; // Wait for initialization to complete
});

test("formatCredentialId", () => {
const testServer = "localhost";
const testDatabase = "TestDb";
const testUser = "testUser";

let credentialId = ConnectionStore.formatCredentialId(
testServer,
testDatabase,
testUser,
ConnectionStore.CRED_MRU_USER,
false, // isConnectionString
);

expect(credentialId).to.equal(
"Microsoft.SqlTools|itemtype:Mru|server:localhost|db:TestDb|user:testUser",
);

credentialId = ConnectionStore.formatCredentialId(
testServer,
testDatabase,
testUser,
undefined, // itemType
true, // isConnectionString
);

expect(credentialId).to.equal(
"Microsoft.SqlTools|itemtype:Profile|server:localhost|db:TestDb|user:testUser|isConnectionString:true",
);

credentialId = ConnectionStore.formatCredentialId(testServer, testDatabase);

expect(credentialId).to.equal(
"Microsoft.SqlTools|itemtype:Profile|server:localhost|db:TestDb",
);

credentialId = ConnectionStore.formatCredentialId(testServer);

expect(credentialId).to.equal("Microsoft.SqlTools|itemtype:Profile|server:localhost");
});
});
Loading