Skip to content

Fix formatting in README notes and refactor tests to be more standardized #7

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
ThisaruGuruge merged 3 commits into from
Feb 28, 2025
Merged

Fix formatting in README notes and refactor tests to be more standardized #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e833f4f
Fix formatting in README notes to meet standards
rtweera Feb 28, 2025
6171b7a
Refactor tests in test.bal to improve structure
rtweera Feb 28, 2025
0f0d5c8
Merge pull request #11 from rtweera/test
rtweera Feb 28, 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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If you have an account already, go to the [HubSpot developer portal](https://app

Within app developer accounts, you can create [developer test accounts](https://developers.hubspot.com/docs/getting-started/account-types#developer-test-accounts) to test apps and integrations without affecting any real HubSpot data.

> **Note: These accounts are only for development and testing purposes. In production you should not use developer test accounts.**
> **Note:** These accounts are only for development and testing purposes. In production you should not use developer test accounts.

1. Go to `Test accounts` section from the left sidebar.
![Test accounts section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.extensions.videoconferencing/refs/heads/main/docs/resources/test-accounts-section.png)
Expand Down
2 changes: 1 addition & 1 deletion ballerina/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you have an account already, go to the [HubSpot developer portal](https://app

Within app developer accounts, you can create [developer test accounts](https://developers.hubspot.com/docs/getting-started/account-types#developer-test-accounts) to test apps and integrations without affecting any real HubSpot data.

> **Note: These accounts are only for development and testing purposes. In production you should not use developer test accounts.**
> **Note:** These accounts are only for development and testing purposes. In production you should not use developer test accounts.

1. Go to `Test accounts` section from the left sidebar.
![Test accounts section](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.extensions.videoconferencing/refs/heads/main/docs/resources/test-accounts-section.png)
Expand Down
111 changes: 54 additions & 57 deletions ballerina/tests/test.bal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,70 +28,72 @@ configurable string localServerUrl = "http://localhost:9090";
configurable boolean isLiveServer = os:getEnv("IS_LIVE_SERVER") == "true";

final int:Signed32 appIdSigned32 = check appId.ensureType();
final int:Signed32 incorrectAppId = 1234;
final string serviceUrl = isLiveServer ? liveServerUrl : localServerUrl;
const int:Signed32 incorrectAppId = 1234;
final Client hubspot = check initClient();

const ExternalSettings partialSettings = {
createMeetingUrl: "https://example.com/create-meeting"
};
const ExternalSettings completeSettings = {
createMeetingUrl: "https://example.com/create-meeting",
updateMeetingUrl: "https://example.com/update-meeting",
deleteMeetingUrl: "https://example.com/delete-meeting",
userVerifyUrl: "https://example.com/verify-user",
fetchAccountsUri: "https://example.com/fetch-accounts"
};

isolated function initClient() returns Client|error {
if isLiveServer {
final ApiKeysConfig apiKeysConfig = {
hapikey
};
return check new (apiKeysConfig, {}, serviceUrl);
return check new (apiKeysConfig, {}, liveServerUrl);
}
return check new ({
hapikey
}, {}, serviceUrl);
}, {}, localServerUrl);
}

// Test: Delete existing settings if any (Positive)
@test:Config {}
function testDeleteSettings() returns error? {
http:Response response = check hubspot->/[appIdSigned32].delete();
test:assertEquals(response.statusCode, 204, "Error deleting settings");
@test:BeforeSuite
function beforeSuite() returns error? {
// Clear all previously saved settings (if any) in HubSpot
http:Response _ = check hubspot->/[appIdSigned32].delete();
}

// Test: Get settings when no settings are available (Negative)
@test:Config {
dependsOn: [testDeleteSettings]
groups: ["negative_tests"]
}
function testGetEmptySettings() returns error? {
// Note: It takes some time for the settings to be updated in HubSpot CRM. Usually 60 seconds is enough.
// However, you can increase or decrease the delay as per your need through the Config.toml.
if isLiveServer {
runtime:sleep(delay);
}
ExternalSettings|http:ClientRequestError|error settings = hubspot->/[appIdSigned32]();
ExternalSettings|error settings = hubspot->/[appIdSigned32]();
test:assertTrue(settings is http:ClientRequestError, "Error getting settings");
}

// Test: Put partial settings (Positive)
@test:Config {
dependsOn: [testGetEmptySettings]
dependsOn: [testGetEmptySettings],
groups: ["positive_tests"]
}
function testPutSettings() returns error? {
ExternalSettings payload = {
createMeetingUrl: "https://example.com/create-meeting"
};
ExternalSettings settings = check hubspot->/[appIdSigned32].put(payload);
test:assertEquals(settings.createMeetingUrl, "https://example.com/create-meeting", "Error putting settings");
function testPartialPutSettings() returns error? {
ExternalSettings settings = check hubspot->/[appIdSigned32].put(partialSettings);
test:assertEquals(settings.createMeetingUrl, partialSettings.createMeetingUrl, "Error putting settings");
}

// Test: Put settings with incorrect appId (Negative)
@test:Config {
dependsOn: [testPutSettings]
dependsOn: [testPartialPutSettings],
groups: ["negative_tests"]
}
function testPutIncorrectAppId() returns error? {
ExternalSettings payload = {
createMeetingUrl: "https://example.com/create-meeting"
};
ExternalSettings|http:ClientRequestError|error settings = hubspot->/[incorrectAppId].put(payload);
ExternalSettings|error settings = hubspot->/[incorrectAppId].put(partialSettings);
test:assertTrue(settings is http:ClientRequestError, "Error putting settings with incorrect appId");
}

// Test: Get settings (Positive)
@test:Config {
dependsOn: [testPutSettings]
dependsOn: [testPartialPutSettings],
groups: ["positive_tests"]
}
function testGetSettings() returns error? {
// Note: It takes some time for the settings to be updated in HubSpot CRM. Usually 60 seconds is enough.
Expand All @@ -102,53 +104,48 @@ function testGetSettings() returns error? {
ExternalSettings|http:Response settings = check hubspot->/[appIdSigned32]();
test:assertTrue(settings is ExternalSettings, "Type mismatch");
if settings is ExternalSettings {
test:assertEquals(settings.createMeetingUrl, "https://example.com/create-meeting", "Error getting settings");
test:assertEquals(settings.createMeetingUrl, partialSettings.createMeetingUrl, "Error getting settings");
}
}

// Test: Delete settings (Positive)
@test:Config {
dependsOn: [testPutSettings]
dependsOn: [testPartialPutSettings],
groups: ["negative_tests"]
}
function testGetIncorrectAppId() returns error? {
ExternalSettings|http:ClientRequestError|error settings = hubspot->/[incorrectAppId]();
test:assertTrue(settings is http:ClientRequestError, "Error getting settings");
ExternalSettings|error settings = hubspot->/[incorrectAppId]();
test:assertTrue(settings is http:ClientRequestError, "Error getting settings with incorrect appId");
}

// Test: Delete settings with incorrect appId (Negative)
@test:Config {
dependsOn: [testGetSettings]
dependsOn: [testGetSettings],
groups: ["negative_tests"]
}
function testDeleteIncorrectAppId() returns error? {
http:Response response = check hubspot->/[incorrectAppId].delete();
test:assertEquals(response.statusCode, 404, "Error deleting settings with incorrect appId");
}

// Test: Put complete settings (Positive)
@test:Config {
dependsOn: [testPutSettings]
}
function testPutCompeteSettings() returns error? {
ExternalSettings payload = {
createMeetingUrl: "https://example.com/create-meeting",
updateMeetingUrl: "https://example.com/update-meeting",
deleteMeetingUrl: "https://example.com/delete-meeting",
userVerifyUrl: "https://example.com/verify-user",
fetchAccountsUri: "https://example.com/fetch-accounts"
};
ExternalSettings settings = check hubspot->/[appIdSigned32].put(payload);
test:assertEquals(settings.createMeetingUrl, "https://example.com/create-meeting", "Error putting complete settings");
test:assertEquals(settings?.updateMeetingUrl, "https://example.com/update-meeting", "Error putting complete settings");
test:assertEquals(settings?.deleteMeetingUrl, "https://example.com/delete-meeting", "Error putting complete settings");
test:assertEquals(settings?.userVerifyUrl, "https://example.com/verify-user", "Error putting complete settings");
test:assertEquals(settings?.fetchAccountsUri, "https://example.com/fetch-accounts", "Error putting complete settings");
}

// Test: Delete complete settings (Positive)
dependsOn: [testPartialPutSettings],
groups: ["positive_tests"]
}
function testPutCompleteSettings() returns error? {
ExternalSettings settings = check hubspot->/[appIdSigned32].put(completeSettings);
test:assertEquals(settings, completeSettings, "Error putting complete settings");
}

@test:Config {
dependsOn: [testGetSettings]
dependsOn: [testGetSettings],
groups: ["positive_tests"]
}
function testDeleteSettingsAgain() returns error? {
function testDeleteCompleteSettings() returns error? {
http:Response response = check hubspot->/[appIdSigned32].delete();
test:assertEquals(response.statusCode, 204, "Error deleting settings");
}

@test:AfterSuite
function afterSuite() returns error? {
// Clear all saved test settings in HubSpot
http:Response _ = check hubspot->/[appIdSigned32].delete();
}
Loading