@azure-tools/typespec-ts 0.53.3 → 0.54.0

package/src/rlc-common/test/buildSampleTest.ts

@@ -0,0 +1,15 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: to fix the handlebars issue
+import hbs from "handlebars";
+import { sampleTestContent } from "./template.js";
+import { RLCModel } from "../interfaces.js";
+
+export function buildSampleTest(model: RLCModel) {
+  return {
+    path: "test/public/sampleTest.spec.ts",
+    content: hbs.compile(sampleTestContent, { noEscape: true })({
+      isEsm: model.options?.moduleKind === "esm",
+      isCjs: model.options?.moduleKind === "cjs"
+    })
+  };
+}

package/src/rlc-common/test/buildSnippets.ts

@@ -0,0 +1,35 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: to fix the handlebars issue
+import hbs from "handlebars";
+import { snippetsContent } from "./template.js";
+import { RLCModel } from "../interfaces.js";
+import { getClientName } from "../helpers/nameConstructors.js";
+
+export function buildSnippets(
+  model: RLCModel,
+  clientName?: string,
+  azureSdkForJs?: boolean
+) {
+  const azureSdkForJsInfo = azureSdkForJs
+    ? azureSdkForJs
+    : model.options?.azureSdkForJs;
+  // to keep the same config for azure scope in buildReadmeFile.ts
+  if (
+    (model?.options?.packageDetails?.scopeName === "azure" ||
+      model?.options?.packageDetails?.scopeName === "azure-rest") &&
+    model.options.addCredentials &&
+    azureSdkForJsInfo
+  ) {
+    return {
+      path: "test/snippets.spec.ts",
+      content: hbs.compile(snippetsContent, { noEscape: true })({
+        clientClassName: clientName ? clientName : getClientName(model),
+        azureArm: model.options?.azureArm,
+        azureSdkForJs: azureSdkForJsInfo,
+        isModularLibrary: model.options.isModularLibrary,
+        hasSubscriptionId: model.options.hasSubscriptionId
+      })
+    };
+  }
+  return undefined;
+}

package/src/rlc-common/test/template.ts

@@ -0,0 +1,263 @@
+export const karmaConfig = `
+// https://github.com/karma-runner/karma-chrome-launcher
+process.env.CHROME_BIN = require("puppeteer").executablePath();
+require("dotenv").config();
+const { relativeRecordingsPath } = require("@azure-tools/test-recorder");
+process.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath();
+
+module.exports = function (config) {
+  config.set({
+    // base path that will be used to resolve all patterns (eg. files, exclude)
+    basePath: "./",
+
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ["source-map-support", "mocha"],
+
+    plugins: [
+      "karma-mocha",
+      "karma-mocha-reporter",
+      "karma-chrome-launcher",
+      "karma-firefox-launcher",
+      "karma-env-preprocessor",
+      "karma-coverage",
+      "karma-sourcemap-loader",
+      "karma-junit-reporter",
+      "karma-source-map-support",
+    ],
+
+    // list of files / patterns to load in the browser
+    files: [
+      "dist-test/index.browser.js",
+      { pattern: "dist-test/index.browser.js.map", type: "html", included: false, served: true },
+    ],
+
+    // list of files / patterns to exclude
+    exclude: [],
+
+    // preprocess matching files before serving them to the browser
+    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
+    preprocessors: {
+      "**/*.js": ["sourcemap", "env"],
+      // IMPORTANT: COMMENT following line if you want to debug in your browsers!!
+      // Preprocess source file to calculate code coverage, however this will make source file unreadable
+      // "dist-test/index.js": ["coverage"]
+    },
+
+    envPreprocessor: [
+      "TEST_MODE",
+      "ENDPOINT",
+      "AZURE_CLIENT_SECRET",
+      "AZURE_CLIENT_ID",
+      "AZURE_TENANT_ID",
+      "SUBSCRIPTION_ID",
+      "RECORDINGS_RELATIVE_PATH",
+    ],
+
+    // test results reporter to use
+    // possible values: 'dots', 'progress'
+    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
+    reporters: ["mocha", "coverage", "junit"],
+
+    coverageReporter: {
+      // specify a common output directory
+      dir: "coverage-browser/",
+      reporters: [
+        { type: "json", subdir: ".", file: "coverage.json" },
+        { type: "lcovonly", subdir: ".", file: "lcov.info" },
+        { type: "html", subdir: "html" },
+        { type: "cobertura", subdir: ".", file: "cobertura-coverage.xml" },
+      ],
+    },
+
+    junitReporter: {
+      outputDir: "", // results will be saved as $outputDir/$browserName.xml
+      outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile
+      suite: "", // suite will become the package name attribute in xml testsuite element
+      useBrowserName: false, // add browser name to report and classes names
+      nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element
+      classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element
+      properties: {}, // key value pair of properties to add to the <properties> section of the report
+    },
+
+    // web server port
+    port: 9876,
+
+    // enable / disable colors in the output (reporters and logs)
+    colors: true,
+
+    // level of logging
+    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
+    logLevel: config.LOG_INFO,
+
+    // enable / disable watching file and executing tests whenever any file changes
+    autoWatch: false,
+
+    // --no-sandbox allows our tests to run in Linux without having to change the system.
+    // --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex.
+    browsers: ["ChromeHeadlessNoSandbox"],
+    customLaunchers: {
+      ChromeHeadlessNoSandbox: {
+        base: "ChromeHeadless",
+        flags: ["--no-sandbox", "--disable-web-security"],
+      },
+    },
+
+    // Continuous Integration mode
+    // if true, Karma captures browsers, runs the tests and exits
+    singleRun: false,
+
+    // Concurrency level
+    // how many browser should be started simultaneous
+    concurrency: 1,
+
+    browserNoActivityTimeout: 60000000,
+    browserDisconnectTimeout: 10000,
+    browserDisconnectTolerance: 3,
+
+    client: {
+      mocha: {
+        // change Karma's debug.html to the mocha web reporter
+        reporter: "html",
+        timeout: "600000",
+      },
+    },
+  });
+};
+`;
+
+export const recordedClientContent = `
+
+{{#if isEsm}}
+import {
+  Recorder,
+  RecorderStartOptions,
+  VitestTestContext,
+} from "@azure-tools/test-recorder";
+{{/if}}
+
+{{#if isCjs}}
+import { Context } from "mocha";
+import { Recorder, RecorderStartOptions } from "@azure-tools/test-recorder";
+{{/if}}
+
+const replaceableVariables: Record<string, string> = {
+  SUBSCRIPTION_ID: "azure_subscription_id"
+};
+
+const recorderEnvSetup: RecorderStartOptions = {
+  envSetupForPlayback: replaceableVariables,
+};
+
+/**
+ * creates the recorder and reads the environment variables from the \`.env\` file.
+ * Should be called first in the test suite to make sure environment variables are
+ * read before they are being used.
+ */
+{{#if isEsm}}
+export async function createRecorder(context: VitestTestContext): Promise<Recorder> {
+  const recorder = new Recorder(context);
+  await recorder.start(recorderEnvSetup);
+  return recorder;
+}
+{{/if}}
+
+{{#if isCjs}}
+export async function createRecorder(context: Context): Promise<Recorder> {
+  const recorder = new Recorder(context.currentTest);
+  await recorder.start(recorderEnvSetup);
+  return recorder;
+}
+{{/if}}
+`;
+
+export const sampleTestContent = `
+{{#if isEsm}}
+// import { Recorder } from "@azure-tools/test-recorder";
+// import { createRecorder } from "./utils/recordedClient.js";
+import { assert, 
+         // beforeEach,
+         // afterEach,
+         it,
+         describe
+} from "vitest";
+{{/if}}
+
+{{#if isCjs}}
+// import { Recorder } from "@azure-tools/test-recorder";
+import { assert } from "chai";
+// import { createRecorder } from "./utils/recordedClient{{#if isModularLibrary}}.js{{/if}}";
+// import { Context } from "mocha";
+{{/if}}
+
+describe("My test", () => {
+  // let recorder: Recorder;
+
+  // beforeEach(async function({{#if isCjs}}this: Context{{else}}ctx{{/if}}) {
+    {{#if isEsm}}
+    // recorder = await createRecorder(ctx);
+    {{else}}
+    // recorder = await createRecorder(this);
+    {{/if}}
+  // });
+
+  // afterEach(async function() {
+    // await recorder.stop();
+  // });
+
+  it("sample test", async function() {
+    assert.equal(1, 1);
+  });
+});
+`;
+
+export const snippetsContent = `
+{{#if isModularLibrary}}
+import { {{ clientClassName }} } from "../src/index.js";
+import { DefaultAzureCredential, InteractiveBrowserCredential } from "@azure/identity";
+{{/if}}
+import { setLogLevel } from "@azure/logger";
+import { describe, it } from "vitest";
+
+describe("snippets", () => {
+{{#if isModularLibrary}}
+  it("ReadmeSampleCreateClient_Node", async () => {
+    {{#if azureArm}}
+    {{#if hasSubscriptionId}}
+    const subscriptionId = "00000000-0000-0000-0000-000000000000";
+    const client = new {{ clientClassName }}(new DefaultAzureCredential(), subscriptionId);
+    {{else}}
+    const client = new {{ clientClassName }}(new DefaultAzureCredential());
+    {{/if}}
+    {{else}}
+    const client = new {{ clientClassName }}("<endpoint>", new DefaultAzureCredential());
+    {{/if}}
+  });
+
+  it("ReadmeSampleCreateClient_Browser", async () => {
+    {{#if azureArm}}
+    const credential = new InteractiveBrowserCredential({
+      tenantId: "<YOUR_TENANT_ID>",
+      clientId: "<YOUR_CLIENT_ID>",
+    });
+    {{#if hasSubscriptionId}}
+    const subscriptionId = "00000000-0000-0000-0000-000000000000";
+    const client = new {{ clientClassName }}(credential, subscriptionId);
+    {{else}}
+    const client = new {{ clientClassName }}(credential);
+    {{/if}}
+    {{else}}
+    const credential = new InteractiveBrowserCredential({
+      tenantId: "<YOUR_TENANT_ID>",
+      clientId: "<YOUR_CLIENT_ID>",
+    });
+    const client = new {{ clientClassName }}("<endpoint>", credential);
+    {{/if}}
+  });
+  {{/if}}
+
+  it("SetLogLevel", async () => {
+    setLogLevel("info");
+  });
+});
+`;