8000 Adding some MultiUser tests by vineeththomasalex · Pull Request #334 · microsoft/devhomegithubextension · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Jun 5, 2025. It is now read-only.

Adding some MultiUser tests #334

Merged
EricJohnson327 merged 1 commit into from
Jan 26, 2024
Merged

Adding some MultiUser tests #334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
106 changes: 106 additions & 0 deletions test/GitHubExtension/DeveloperId/CredentialVaultTests.cs
View file
Open in desktop
10BC0
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
// Copyright (c) Microsoft Corporation and Contributors
// Licensed under the MIT license.

using System.Net;
using GitHubExtension.DeveloperId;

namespace GitHubExtension.Test;

// Unit Tests for CredentialVault
public partial class DeveloperIdTests
{
[TestMethod]
[TestCategory("Unit")]
public void CredentialVault_CreateSingleton()
{
var credentialVault1 = new CredentialVault("DevHomeGitHubExtensionTest");
Assert.IsNotNull(credentialVault1);
Copy link
Contributor
@AmelBawa-msft AmelBawa-msft Jan 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: constructor won't return null
** all occurrences **


var credentialVault2 = new CredentialVault("DevHomeGitHubExtensionTest");
Assert.IsNotNull(credentialVault2);

Assert.AreNotEqual(credentialVault1, credentialVault2);
Copy link
Contributor
@AmelBawa-msft AmelBawa-msft Jan 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test name CreateSingleton hints that those two should be equal. Consider renaming the unit test or add comments.


credentialVault1.RemoveAllCredentials();
Assert.AreEqual(0, credentialVault1.GetAllCredentials().Count());
}

[TestMethod]
[TestCategory("LiveData")]
[DataRow("testuser1")]
[DataRow("https://github.com/testuser2")]
[DataRow("https://RandomWebServer.example/testuser3")]
public void CredentialVault_SaveAndRetrieveCredential(string loginId)
{
var credentialVault = new CredentialVault("DevHomeGitHubExtensionTest");
Assert.IsNotNull(credentialVault);
Assert.AreEqual(0, credentialVault.GetAllCredentials().Count());

var nullCredential = credentialVault.GetCredentials(loginId);
Assert.IsNull(nullCredential);

var testCredential = "testcredential";

var credential = new NetworkCredential(null, testCredential).SecurePassword;
credentialVault.SaveCredentials(loginId, credential);

var retrievedCredential = credentialVault.GetCredentials(loginId);
Assert.IsNotNull(retrievedCredential);
Assert.AreEqual(testCredential, retrievedCredential.Password);

credentialVault.RemoveAllCredentials();
Assert.AreEqual(0, credentialVault.GetAllCredentials().Count());
}

[TestMethod]
[TestCategory("LiveData")]
[DataRow("testuser1")]
[DataRow("https://github.com/testuser2")]
[DataRow("https://RandomWebServer.example/testuser3")]
public void CredentialVault_RemoveAndRetrieveCredential(string loginId)
{
var credentialVault = new CredentialVault("DevHomeGitHubExtensionTest");
Assert.IsNotNull(credentialVault);

var testCredential = "testCredential";

var credential = new NetworkCredential(null, testCredential).SecurePassword;
credentialVault.SaveCredentials(loginId, credential);

var retrievedCredential = credentialVault.GetCredentials(loginId);
Assert.IsNotNull(retrievedCredential);
Assert.AreEqual(testCredential, retrievedCredential.Password);

credentialVault.RemoveCredentials(loginId);

var nullCredential = credentialVault.GetCredentials(loginId);
Assert.IsNull(nullCredential);

Assert.AreEqual(0, credentialVault.GetAllCredentials().Count());
}

[TestMethod]
[TestCategory("LiveData")]
public void CredentialVault_GetAllCredentials()
{
var credentialVault = new CredentialVault("DevHomeGitHubExtensionTest");
Assert.IsNotNull(credentialVault);

Assert.AreEqual(0, credentialVault.GetAllCredentials().Count());

var testLoginId = "testuser1";
var testCredential = "testCredential";

var credential = new NetworkCredential(null, testCredential).SecurePassword;
credentialVault.SaveCredentials(testLoginId, credential);

Assert.AreEqual(1, credentialVault.GetAllCredentials().Count());

credentialVault.RemoveCredentials(testLoginId);

Assert.AreEqual(0, credentialVault.GetAllCredentials().Count());

var nullCredential = credentialVault.GetCredentials(testLoginId);
Assert.IsNull(nullCredential);
}
}
51 changes: 51 additions & 0 deletions test/GitHubExtension/DeveloperId/DeveloperIdProviderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,32 @@ private CredentialVault SetupCredentialVaultWithGHESTestUser()
return credentialVault;
}

/* Tests depend on the following environment variables:
* DEV_HOME_TEST_GITHUB_COM_USER : Url for a test user on github.com
* DEV_HOME_TEST_GITHUB_COM_PAT : Personal Access Token for the test user on github.com
* DEV_HOME_TEST_GITHUB_ENTERPRISE_SERVER_USER : Url for a test user on GHES
* DEV_HOME_TEST_GITHUB_ENTERPRISE_SERVER_PAT : Personal Access Token for the test user on the GHES
*/
private CredentialVault SetupCredentialVaultWithMultipleTestUsers()
{
var credentialVault = SetupCleanCredentialVaultClean();

var testLoginId = Environment.GetEnvironmentVariable("DEV_HOME_TEST_GITHUB_COM_USER") ?? string.Empty;
var testPassword = Environment.GetEnvironmentVariable("DEV_HOME_TEST_GITHUB_COM_PAT");

var testGHESLoginId = Environment.GetEnvironmentVariable("DEV_HOME_TEST_GITHUB_ENTERPRISE_SERVER_USER") ?? string.Empty;
var testGHESPassword = Environment.GetEnvironmentVariable("DEV_HOME_TEST_GITHUB_ENTERPRISE_SERVER_PAT");

var password = new NetworkCredential(null, testPassword).SecurePassword;
credentialVault.SaveCredentials(testLoginId, password);

var ghesPassword = new NetworkCredential(null, testGHESPassword).SecurePassword;
credentialVault.SaveCredentials(testGHESLoginId, ghesPassword);

Assert.AreEqual(2, credentialVault.GetAllCredentials().Count());
return credentialVault;
}

private CredentialVault SetupCredentialVaultWithInvalidTestUser()
{
var credentialVault = SetupCleanCredentialVaultClean();
Expand Down Expand Up @@ -129,6 +155,31 @@ public void DeveloperIdProvider_RestoreAndGetDeveloperIds()
Assert.AreEqual(0, credentialVault.GetAllCredentials().Count());
}

[TestMethod]
[TestCategory("LiveData")]
public void DeveloperIdProvider_RestoreAndGetMultipleDeveloperIds()
{
// Setup CredentialVault with a dummy testuser and valid PAT for Github.com
var credentialVault = SetupCredentialVaultWithMultipleTestUsers();

// Test whether the DeveloperIdProvider can restore the saved credentials
var devIdProvider = DeveloperIdProvider.GetInstance();
Assert.IsNotNull(devIdProvider);
var result = devIdProvider.GetLoggedInDeveloperIds();

Assert.IsNotNull(result);
Assert.AreEqual(ProviderOperationStatus.Success, result.Result.Status);
Assert.AreEqual(2, result.DeveloperIds.Count());
Assert.AreNotEqual("dummytestuser1", result.DeveloperIds.First().LoginId);
Assert.AreNotEqual("dummytestuser1", result.DeveloperIds.Last().LoginId);
Assert.IsNotNull(new Uri(result.DeveloperIds.First().Url));
Copy link
Contributor
@AmelBawa-msft AmelBawa-msft Jan 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using Assert.DoesNotThrow because Assert.IsNotNull will either pass or its argument will throw an exception.

Assert.IsNotNull(new Uri(result.DeveloperIds.Last().Url));

// Cleanup
credentialVault.RemoveAllCredentials();
Assert.AreEqual(0, credentialVault.GetAllCredentials().Count());
}

[TestMethod]
[TestCategory("LiveData")]
public void DeveloperIdProvider_GetDeveloperIds_InvalidPAT()
Expand Down
0