TypeScript ToolingLog.info方法代碼示例

    this.loggingInterval = setInterval(() => {
      if (this.complete === undefined) {
        return;
      }

      if (this.total === undefined) {
        log.info('progress: %d', this.getComplete());
        return;
      }

      log.info('progress: %d/%d (%d%)', this.getComplete(), this.getTotal(), this.getPercent());
    }, 10 * SECOND);

 messageCallback: (message: ExtractorMessage) => {
   if (message.messageId === 'console-api-report-not-copied') {
     // ConsoleMessageId.ApiReportNotCopied
     log.warning(`You have changed the signature of the ${folder} Core API`);
     log.warning(
       'To accept these changes run `node scripts/check_core_api_changes.js --accept` and then:\n' +
         "\t 1. Commit the updated documentation and API review file '" +
         config.reportFilePath +
         "' \n" +
         "\t 2. Describe the change in your PR including whether it's a major, minor or patch"
     );
     message.handled = true;
   } else if (message.messageId === 'console-api-report-copied') {
     // ConsoleMessageId.ApiReportCopied
     log.warning(`You have changed the signature of the ${folder} Core API`);
     log.warning(
       "Please commit the updated API documentation and the review file in '" +
         config.reportFilePath
     );
     message.handled = true;
   } else if (message.messageId === 'console-api-report-unchanged') {
     // ConsoleMessageId.ApiReportUnchanged
     log.info(`Core ${folder} API: no changes detected ✔`);
     message.handled = true;
   }
 },

export async function startTestServers({
  adjustTimeout,
  settings = {},
}: {
  adjustTimeout: (timeout: number) => void;
  settings: Record<string, any>;
}) {
  if (!adjustTimeout) {
    throw new Error('adjustTimeout is required in order to avoid flaky tests');
  }

  const log = new ToolingLog({
    level: 'debug',
    writeTo: process.stdout,
  });

  log.indent(6);
  log.info('starting elasticsearch');
  log.indent(4);

  const es = createEsTestCluster({ log });

  log.indent(-4);

  adjustTimeout(es.getStartTimeout());

  await es.start();

  const root = createRootWithCorePlugins(settings);
  await root.start();

  const kbnServer = getKbnServer(root);
  await kbnServer.server.plugins.elasticsearch.waitUntilReady();

  return {
    kbnServer,
    root,
    es,

    async stop() {
      await root.shutdown();
      await es.cleanup();
    },
  };
}

export async function startTestServers({
  adjustTimeout,
  settings = {},
}: {
  adjustTimeout: (timeout: number) => void;
  settings: {
    es?: {
      license: 'oss' | 'basic' | 'gold' | 'trial';
      [key: string]: any;
    };
    kbn?: {
      /**
       * An array of directories paths, passed in via absolute path strings
       */
      plugins?: {
        paths: string[];
        [key: string]: any;
      };
      [key: string]: any;
    };
    /**
     * Users passed in via this prop are created in ES in adition to the standard elastic and kibana users.
     * Note, this prop is ignored when using an oss, or basic license
     */
    users?: Array<{ username: string; password: string; roles: string[] }>;
  };
}) {
  if (!adjustTimeout) {
    throw new Error('adjustTimeout is required in order to avoid flaky tests');
  }
  const license = get<'oss' | 'basic' | 'gold' | 'trial'>(settings, 'es.license', 'oss');
  const usersToBeAdded = get(settings, 'users', []);
  if (usersToBeAdded.length > 0) {
    if (license !== 'trial') {
      throw new Error(
        'Adding users is only supported by startTestServers when using a trial license'
      );
    }
  }

  const log = new ToolingLog({
    level: 'debug',
    writeTo: process.stdout,
  });

  log.indent(6);
  log.info('starting elasticsearch');
  log.indent(4);

  const es = createEsTestCluster(
    defaultsDeep({}, get(settings, 'es', {}), {
      log,
      license,
      password: license === 'trial' ? DEFAULT_SUPERUSER_PASS : undefined,
    })
  );

  log.indent(-4);

  // Add time for KBN and adding users
  adjustTimeout(es.getStartTimeout() + 100000);

  await es.start();

  const kbnSettings: any = get(settings, 'kbn', {});
  if (['gold', 'trial'].includes(license)) {
    await setupUsers(log, esTestConfig.getUrlParts().port, [
      ...usersToBeAdded,
      // user elastic
      esTestConfig.getUrlParts(),
      // user kibana
      kbnTestConfig.getUrlParts(),
    ]);

    // Override provided configs, we know what the elastic user is now
    kbnSettings.elasticsearch = {
      hosts: [esTestConfig.getUrl()],
      username: esTestConfig.getUrlParts().username,
      password: esTestConfig.getUrlParts().password,
    };
  }

  const root = createRootWithCorePlugins(kbnSettings);

  await root.setup();
  await root.start();

  const kbnServer = getKbnServer(root);
  await kbnServer.server.plugins.elasticsearch.waitUntilReady();

  return {
    kbnServer,
    root,
    es,

    async stop() {
      await root.shutdown();
      await es.cleanup();
    },
  };
//.........這裏部分代碼省略.........

async function run(folder: string): Promise<boolean> {
  const log = new ToolingLog({
    level: 'info',
    writeTo: process.stdout,
  });

  const extraFlags: string[] = [];
  const opts = getopts(process.argv.slice(2), {
    boolean: ['accept', 'docs', 'help'],
    default: {
      project: undefined,
    },
    unknown(name) {
      extraFlags.push(name);
      return false;
    },
  });

  if (extraFlags.length > 0) {
    for (const flag of extraFlags) {
      log.error(`Unknown flag: ${flag}`);
    }

    opts.help = true;
  }

  if (opts.help) {
    process.stdout.write(
      dedent(chalk`
        {dim usage:} node scripts/check_core_api_changes [...options]

        Checks for any changes to the Kibana Core API

        Examples:

          {dim # Checks for any changes to the Kibana Core API}
          {dim $} node scripts/check_core_api_changes

          {dim # Checks for any changes to the Kibana Core API and updates the documentation}
          {dim $} node scripts/check_core_api_changes --docs

          {dim # Checks for and automatically accepts and updates documentation for any changes to the Kibana Core API}
          {dim $} node scripts/check_core_api_changes --accept

        Options:
          --accept    {dim Accepts all changes by updating the API Review files and documentation}
          --docs      {dim Updates the Core API documentation}
          --help      {dim Show this message}
      `)
    );
    process.stdout.write('\n');
    return !(extraFlags.length > 0);
  }

  log.info(`Core ${folder} API: checking for changes in API signature...`);

  try {
    await runBuildTypes();
  } catch (e) {
    log.error(e);
    return false;
  }

  const { apiReportChanged, succeeded } = runApiExtractor(log, folder, opts.accept);

  // If we're not accepting changes and there's a failure, exit.
  if (!opts.accept && !succeeded) {
    return false;
  }

  // Attempt to generate docs even if api-extractor didn't succeed
  if ((opts.accept && apiReportChanged) || opts.docs) {
    try {
      await renameExtractedApiPackageName(folder);
      await runApiDocumenter(folder);
    } catch (e) {
      log.error(e);
      return false;
    }
    log.info(`Core ${folder} API: updated documentation ✔`);
  }

  // If any errors or warnings occured, exit with an error
  return succeeded;
}

 const info = (msg: string, ...args: any[]) => log.info(`[${name}] ${msg}`, ...args);