Skip to content

Rewrite test cases in TS #24

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.

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
merged 2 commits into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,6 @@
"avoidEscape": true
}
],
},
"@typescript-eslint/no-explicit-any": "off"
}
}
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,7 @@ FodyWeavers.xsd
# bundled folder
dist/
dist-esm/
out/
types/

# dotenv
Expand All @@ -409,4 +410,4 @@ types/
*.tgz

# examples
examples/package-lock.json
examples/package-lock.json
57 changes: 57 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 8 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@
"README.md"
],
"scripts": {
"build": "npm run clean && npm run build-cjs && npm run build-esm",
"build": "npm run clean && npm run build-cjs && npm run build-esm && npm run build-test",
"build-cjs": "rollup --config",
"build-esm": "tsc -p ./",
"clean": "rimraf dist dist-esm types",
"build-esm": "tsc -p ./tsconfig.json",
"build-test": "tsc -p ./tsconfig.test.json",
"clean": "rimraf dist dist-esm out types",
"dev": "rollup --config --watch",
"lint": "eslint src/ test/",
"fix-lint": "eslint src/ test/ --fix",
"test": "mocha --timeout 10000"
"test": "mocha out/test/*.test.{js,cjs,mjs} --timeout 10000"
},
"repository": {
"type": "git",
Expand All @@ -33,7 +34,10 @@
"license": "MIT",
"devDependencies": {
"@rollup/plugin-typescript": "^11.1.2",
"@types/mocha": "^10.0.4",
"@types/node": "^20.5.7",
"@types/sinon": "^17.0.1",
"@types/uuid": "^9.0.7",
"@typescript-eslint/eslint-plugin": "^6.6.0",
"@typescript-eslint/parser": "^6.6.0",
"chai": "^4.3.7",
Expand Down
2 changes: 1 addition & 1 deletion src/AzureAppConfiguration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

export type AzureAppConfiguration = {
// methods for advanced features, e.g. refresh()
} & ReadonlyMap<string, unknown>;
} & ReadonlyMap<string, any>;
5 changes: 0 additions & 5 deletions test/.eslintrc

This file was deleted.

15 changes: 9 additions & 6 deletions test/clientOptions.test.js → test/clientOptions.test.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

const chai = require("chai");
const chaiAsPromised = require("chai-as-promised");
import * as chai from "chai";
import * as chaiAsPromised from "chai-as-promised";
chai.use(chaiAsPromised);
const expect = chai.expect;
const { load } = require("../dist/index");
const { createMockedConnectionString } = require("./utils/testHelper");
const nock = require("nock");
import { load } from "./exportedApi";
import { createMockedConnectionString } from "./utils/testHelper";
import * as nock from "nock";

class HttpRequestCountPolicy {
count: number;
name: string;

constructor() {
this.count = 0;
this.name = "HttpRequestCountPolicy";
Expand Down Expand Up @@ -58,7 +61,7 @@ describe("custom client options", function () {

it("should override default retry options", async () => {
const countPolicy = new HttpRequestCountPolicy();
const loadWithMaxRetries = (maxRetries) => {
const loadWithMaxRetries = (maxRetries: number) => {
return load(createMockedConnectionString(fakeEndpoint), {
clientOptions: {
additionalPolicies: [{
Expand Down
4 changes: 4 additions & 0 deletions test/exportedApi.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

export { load } from "../src";
14 changes: 4 additions & 10 deletions test/json.test.js → test/json.test.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

const chai = require("chai");
const chaiAsPromised = require("chai-as-promised");
import * as chai from "chai";
import * as chaiAsPromised from "chai-as-promised";
chai.use(chaiAsPromised);
const expect = chai.expect;
const { load } = require("../dist/index");
const {
mockAppConfigurationClientListConfigurationSettings,
restoreMocks,
createMockedConnectionString,
createMockedKeyVaultReference,
createMockedJsonKeyValue
} = require("./utils/testHelper");
import { load } from "./exportedApi";
import { mockAppConfigurationClientListConfigurationSettings, restoreMocks, createMockedConnectionString, createMockedKeyVaultReference, createMockedJsonKeyValue } from "./utils/testHelper";

const jsonKeyValue = createMockedJsonKeyValue("json.settings.logging", '{"Test":{"Level":"Debug"},"Prod":{"Level":"Warning"}}');
const keyVaultKeyValue = createMockedKeyVaultReference("TestKey", "https://fake-vault-name.vault.azure.net/secrets/fakeSecretName");
Expand Down
17 changes: 7 additions & 10 deletions test/keyvault.test.js → test/keyvault.test.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

const chai = require("chai");
const chaiAsPromised = require("chai-as-promised");
import * as chai from "chai";
import * as chaiAsPromised from "chai-as-promised";
chai.use(chaiAsPromised);
const expect = chai.expect;
const { load } = require("../dist/index");
const { sinon,
createMockedConnectionString,
createMockedTokenCredential,
mockAppConfigurationClientListConfigurationSettings, mockSecretClientGetSecret, restoreMocks, createMockedKeyVaultReference } = require("./utils/testHelper");
const { SecretClient } = require("@azure/keyvault-secrets");
import { load } from "./exportedApi";
import { sinon, createMockedConnectionString, createMockedTokenCredential, mockAppConfigurationClientListConfigurationSettings, mockSecretClientGetSecret, restoreMocks, createMockedKeyVaultReference } from "./utils/testHelper";
import { KeyVaultSecret, SecretClient } from "@azure/keyvault-secrets";

const mockedData = [
// key, secretUri, value
Expand Down Expand Up @@ -72,9 +69,9 @@ describe("key vault reference", function () {

// mock specific behavior per secret client
const client1 = new SecretClient("https://fake-vault-name.vault.azure.net", createMockedTokenCredential());
sinon.stub(client1, "getSecret").returns({ value: "SecretValueViaClient1" });
sinon.stub(client1, "getSecret").returns(Promise.resolve({value: "SecretValueViaClient1" } as KeyVaultSecret));
const client2 = new SecretClient("https://fake-vault-name2.vault.azure.net", createMockedTokenCredential());
sinon.stub(client2, "getSecret").returns({ value: "SecretValueViaClient2" });
sinon.stub(client2, "getSecret").returns(Promise.resolve({value: "SecretValueViaClient2" } as KeyVaultSecret));
const settings = await load(createMockedConnectionString(), {
keyVaultOptions: {
secretClients: [
Expand Down
15 changes: 4 additions & 11 deletions test/load.test.js → test/load.test.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,12 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

const chai = require("chai");
const chaiAsPromised = require("chai-as-promised");
import * as chai from "chai";
import * as chaiAsPromised from "chai-as-promised";
chai.use(chaiAsPromised);
const expect = chai.expect;
const { load } = require("../dist/index");
const {
mockAppConfigurationClientListConfigurationSettings,
restoreMocks,
createMockedConnectionString,
createMockedEnpoint,
createMockedTokenCredential,
createMockedKeyValue,
} = require("./utils/testHelper");
import { load } from "./exportedApi";
import { mockAppConfigurationClientListConfigurationSettings, restoreMocks, createMockedConnectionString, createMockedEnpoint, createMockedTokenCredential, createMockedKeyValue } from "./utils/testHelper";

const mockedKVs = [{
key: "app.settings.fontColor",
Expand Down
19 changes: 11 additions & 8 deletions test/requestTracing.test.js → test/requestTracing.test.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

const chai = require("chai");
const chaiAsPromised = require("chai-as-promised");
import * as chai from "chai";
import * as chaiAsPromised from "chai-as-promised";
chai.use(chaiAsPromised);
const expect = chai.expect;
const { load } = require("../dist/index");
const { createMockedConnectionString, createMockedTokenCredential } = require("./utils/testHelper");

import { createMockedConnectionString, createMockedTokenCredential } from "./utils/testHelper";
import { load } from "./exportedApi";
class HttpRequestHeadersPolicy {
headers: any;
name: string;

constructor() {
this.headers = {};
this.name = "HttpRequestHeadersPolicy";
Expand All @@ -22,13 +24,14 @@ class HttpRequestHeadersPolicy {
describe("request tracing", function () {
const fakeEndpoint = "https://127.0.0.1"; // sufficient to test the request it sends out
const headerPolicy = new HttpRequestHeadersPolicy();
const position: "perCall" | "perRetry" = "perCall";
const clientOptions = {
retryOptions: {
maxRetries: 0 // save time
},
additionalPolicies: [{
policy: headerPolicy,
position: "perCall"
position
}]
};

Expand All @@ -43,7 +46,7 @@ describe("request tracing", function () {
await load(createMockedConnectionString(fakeEndpoint), { clientOptions });
} catch (e) { /* empty */ }
expect(headerPolicy.headers).not.undefined;
expect(headerPolicy.headers.get("User-Agent")).satisfy(ua => ua.startsWith("javascript-appconfiguration-provider"));
expect(headerPolicy.headers.get("User-Agent")).satisfy((ua: string) => ua.startsWith("javascript-appconfiguration-provider"));
});

it("should have request type in correlation-context header", async () => {
Expand Down Expand Up @@ -99,7 +102,7 @@ describe("request tracing", function () {
delete process.env.WEBSITE_SITE_NAME;
});

it("should disable request tracing when AZURE_APP_CONFIGURATION_TRACING_DISABLED is true", async() => {
it("should disable request tracing when AZURE_APP_CONFIGURATION_TRACING_DISABLED is true", async () => {
for (const indicator of ["TRUE", "true"]) {
process.env.AZURE_APP_CONFIGURATION_TRACING_DISABLED = indicator;
try {
Expand Down
Loading