Add support for bdd-runner (#2166)

* begin adding bdd-runner

* bdd-runner cli and entry point

* cleanup

* basic api support

* basic given support

* basic undo support

* rename directory

* add back assertions and object serialization

* fix up additional tests and path resolution

* fix api name resolution

* run in ci

* remove examples dep and bump min version

* lint

* [AAWF-316] Add back licenses check (#2176)

* add back licenses check

* run it in tests

Author: skarimo

.github/workflows/test.yml

@@ -15,7 +15,7 @@ on:
     - cron: "0 5 * * *"
 
 concurrency:
-  group: unit-${{ github.head_ref }}
+  group: unit-split-package-${{ github.head_ref }}
   cancel-in-progress: true
 
 jobs:
@@ -56,7 +56,7 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pre-commit
-          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+          key: pre-commit|split-package|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
       - id: pre_commit
         name: Run generate to fix lint and format
         if: github.event.action != 'closed' && github.event.pull_request.merged != true
@@ -77,3 +77,59 @@ jobs:
         if: github.event_name == 'schedule'
         run: |
           pre-commit run --all-files --show-diff-on-failure --color=always
+
+  test:
+    strategy:
+      matrix:
+        node-version: ["18", "20"]
+        platform: [ubuntu-latest]
+    runs-on: ${{ matrix.platform }}
+    if: (github.event.pull_request.draft == false && !contains(github.event.pull_request.labels.*.name, 'ci/skip') && !contains(github.event.pull_request.head.ref, 'datadog-api-spec/test/')) || github.event_name == 'schedule'
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - name: Test
+        run: ./run-tests.sh
+        shell: bash
+
+  # examples:
+  #   runs-on: ubuntu-latest
+  #   if: (github.event.pull_request.draft == false && !contains(github.event.pull_request.labels.*.name, 'ci/skip') && !contains(github.event.pull_request.head.ref, 'datadog-api-spec/test/')) || github.event_name == 'schedule'
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - name: Set up Node 16
+  #       uses: actions/setup-node@v3
+  #       with:
+  #         node-version: 16
+  #         cache: 'yarn'
+  #     - name: Check examples
+  #       run: ./check-examples.sh
+  #       shell: bash
+
+  report:
+    runs-on: ubuntu-latest
+    if: always() && github.event_name == 'pull_request' && contains(github.event.pull_request.head.ref, 'datadog-api-spec/generated/')
+    needs:
+      - test
+      # - examples
+    steps:
+      - name: Get GitHub App token
+        if: github.event_name == 'pull_request'
+        id: get_token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
+          private-key: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
+          repositories: datadog-api-spec
+      - name: Post status check
+        uses: DataDog/github-actions/post-status-check@v2
+        with:
+          github-token: ${{ steps.get_token.outputs.token }}
+          repo: datadog-api-spec
+          # status: ${{ (needs.test.result == 'cancelled' || needs.examples.result == 'cancelled') && 'pending' || needs.test.result == 'success' && needs.examples.result == 'success' && 'success' || 'failure' }}
+          status: ${{ needs.test.result == 'cancelled' && 'pending' || needs.test.result == 'success' && 'success' || 'failure' }}
+          context: unit

LICENSE-3rdparty.csv

@@ -9,26 +9,19 @@ Component,Licence,Copyright
 @types/jest,MIT,Copyright Microsoft Corporation
 @types/node,MIT,Copyright Microsoft Corporation
 @types/pako,MIT,Copyright Caleb Eggensperger Muhammet Öztürk
-@typescript-eslint/eslint-plugin,MIT,Copyright (c) 2019 TypeScript ESLint and other contributors
-@typescript-eslint/parser,BSD-2-Clause,
 buffer-from,MIT,Copyright (c) 2016, 2018 Linus Unnebäck
 chai,MIT,Copyright (c) 2017 Chai.js Assertion Library
 chai-quantifiers,MIT,
 cross-fetch,MIT,Copyright (c) 2017 Leonardo Quixadá
-jest,MIT,Copyright (c) Facebook, Inc. and its affiliates.
-ts-jest,MIT,Copyright (c) 2016-2018
 dd-trace,BSD-3-Clause,Copyright 2016-Present Datadog Inc.
 es6-promise,MIT,Copyright (c) 2014 Yehuda Katz, Tom Dale, Stefan Penner and contributors
-eslint-plugin-import,MIT,Copyright (c) 2015 Ben Mosher
-eslint-plugin-node,MIT,Copyright (c) 2015 Toru Nagashima
-eslint-plugin-unused-imports,MIT,Copyright (c) 2021 Mikkel Holmer
 eslint,MIT,Copyright JS Foundation and other contributors, https://js.foundation
 form-data,MIT,Copyright (c) 2012 Felix Geisendörfer (felix@debuggable.com) and contributors
 pako,MIT,Copyright (C) 2014-2017 Vitaly Puzrin and Andrei Tuputcyn
-nock,MIT,Copyright (c) 2011-2019 Pedro Teixeira and other contributors
 prettier,MIT,Copyright © James Long and contributors
 ts-node,MIT,Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com)
-typedoc,Apache-2.0,Copyright (c) 2015 Sebastian Lenz Copyright (c) 2016-2021 TypeDoc Contributors.
 typescript,Apache-2.0,Copyright (c) Microsoft Corporation.
 loglevel,MIT,Copyright (c) 2013 Tim Perry
 zstd.ts,BSD-2-Clause,Copyright (c) [2021] [Beeno Tung (Tung Cheung Leong)]
+commander,MIT,(c) 2011 TJ Holowaychuk
+typescript-eslint,MIT,2019 typescript-eslint and other contributors

bin/check-licenses.js

@@ -0,0 +1,81 @@
+"use strict";
+
+const fs = require("fs");
+const path = require("path");
+const readline = require("readline");
+const util = require("util");
+const exec = util.promisify(require("child_process").exec);
+
+const LICENSE_FILE = "LICENSE-3rdparty.csv";
+
+async function main() {
+  const packageJsonPaths = await findPackageJsonPaths();
+
+  console.log(`Look for dependencies in:\n`, packageJsonPaths);
+  const declaredDependencies = withoutDuplicates(
+    packageJsonPaths.flatMap(retrievePackageJsonDependencies),
+  ).sort();
+
+  const declaredLicenses = withoutDuplicates(await retrieveLicenses()).sort();
+
+  if (
+    JSON.stringify(declaredDependencies) !== JSON.stringify(declaredLicenses)
+  ) {
+    console.error(JSON.stringify(declaredDependencies, null, 2));
+    console.error(JSON.stringify(declaredLicenses, null, 2));
+    console.error(
+      `\n❌ package.json dependencies and ${LICENSE_FILE} mismatch`,
+    );
+    console.error(
+      `\nIn package.json but not in ${LICENSE_FILE}:\n`,
+      declaredDependencies.filter((d) => !declaredLicenses.includes(d)),
+    );
+    console.error(
+      `\nIn ${LICENSE_FILE} but not in package.json:\n`,
+      declaredLicenses.filter((d) => !declaredDependencies.includes(d)),
+    );
+    throw new Error("dependencies mismatch");
+  }
+  console.log(`\n✅ All dependencies listed in ${LICENSE_FILE}`);
+}
+
+async function findPackageJsonPaths() {
+  const { stdout } = await exec(
+    'find . -path "*/node_modules/*" -prune -o -name "package.json" -print',
+  );
+  return stdout.trim().split("\n");
+}
+
+function retrievePackageJsonDependencies(packageJsonPath) {
+  const packageJson = require(path.join(__dirname, "..", packageJsonPath));
+
+  return Object.keys(packageJson.dependencies || {})
+    .concat(Object.keys(packageJson.devDependencies || {}))
+    .filter((dependency) => !dependency.includes("@datadog"));
+}
+
+function withoutDuplicates(a) {
+  return [...new Set(a)];
+}
+
+async function retrieveLicenses() {
+  const fileStream = fs.createReadStream(
+    path.join(__dirname, "..", LICENSE_FILE),
+  );
+  const rl = readline.createInterface({ input: fileStream });
+  const licenses = [];
+  let header = true;
+  for await (const line of rl) {
+    const csvColumns = line.split(",");
+    if (!header && csvColumns[0] !== "file") {
+      licenses.push(csvColumns[0]);
+    }
+    header = false;
+  }
+  return licenses;
+}
+
+main().catch((e) => {
+  console.error("\nStacktrace:\n", e);
+  process.exit(1);
+});

package.json

@@ -21,16 +21,18 @@
   "private": true,
   "workspaces": [
     "packages/*",
-    "services/*"
+    "services/*",
+    "private/*"
   ],
   "scripts": {
+    "check-licenses": "node bin/check-licenses.js",
     "build": "yarn workspaces run build",
     "lint": "yarn install --ignore-scripts; eslint --ext .ts packages/* services/*",
     "lint:fix": "yarn install --ignore-scripts;  yarn lint --fix",
-    "format": "yarn install --ignore-scripts; prettier --write --ignore-unknown '**.{js,ts}'"
+    "format": "yarn install --ignore-scripts; prettier --write --ignore-unknown '**.{js,ts}'",
+    "bdd-test": "yarn workspace bdd-runner run start --working-dir \"$(pwd)\" \"features/v*/*.feature\""
   },
   "devDependencies": {
-    "@eslint/js": "^9.23.0",
     "eslint": "^9.23.0",
     "prettier": "^3.5.3",
     "typescript": "^5.8.2",

private/bdd_runner/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "bdd-runner",
+  "repository": {
+    "type": "git",
+    "directory": "private/bdd_runner",
+    "url": "https://github.com/DataDog/datadog-api-client-typescript.git"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "bin": {
+    "bdd-runner": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "ts-node src/index.ts"
+  },
+  "dependencies": {
+    "@cucumber/cucumber": "^9.2.0",
+    "@cucumber/messages": "^22.0.0",
+    "@datadog/datadog-api-client": "^2.0.0-beta.0",
+    "@pollyjs/adapter-node-http": "^6.0.5",
+    "@pollyjs/core": "^6.0.5",
+    "@pollyjs/persister-fs": "^6.0.5",
+    "@types/chai": "^4.3.4",
+    "@types/jest": "^29.5.2",
+    "chai": "^4.3.7",
+    "chai-quantifiers": "^1.0.17",
+    "commander": "^13.1.0",
+    "dd-trace": "^4.3.0",
+    "@types/node": "*",
+    "ts-node": "^10.9.1",
+    "zstd.ts": "^1.1.3"
+  },
+  "devDependencies": {
+    "typescript": "4.8.4"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "version": "0.0.1",
+  "private": true,
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}

private/bdd_runner/src/index.ts

@@ -0,0 +1,94 @@
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import Cli from "@cucumber/cucumber/lib/cli/index";
+
+import path from "path";
+
+let cwd = process.cwd();
+const program = new Command();
+program
+  .name("bdd-runner")
+  .description("A BDD test runner with Datadog integration")
+  .option(
+    "--working-dir <path>",
+    "Fully qualified path to working directory",
+    cwd,
+  )
+  .option(
+    "--cassettes-dir <path>",
+    "Fully qualified path to cassettes directory",
+  )
+  .option("--services-dir <path>", "Fully qualified path to services directory")
+  .option(
+    "--package-prefix <prefix>",
+    "Prefix to add to the package name",
+    "@datadog/datadog-api-client",
+  )
+  .option(
+    "--additional-givens <additionalGivens>",
+    "Additional given files to be added to cucumber. The value is mapping of version to the given file.",
+  )
+  .argument("<feature>", "Fully qualified path to feature files")
+  .parse(process.argv);
+
+const options = program.opts();
+
+// Initialize Datadog tracing if enabled and host is set
+if (process.env.DD_AGENT_HOST != undefined) {
+  require("dd-trace/ci/init");
+}
+
+if (options.workingDir) {
+  cwd = options.workingDir;
+}
+let worldParameters = {};
+worldParameters["workingDir"] = cwd;
+worldParameters["cassettesDir"] =
+  options.cassettesDir || path.resolve(cwd, "cassettes");
+worldParameters["packagePrefix"] = options.packagePrefix;
+worldParameters["servicesDir"] =
+  options.servicesDir || path.resolve(cwd, "services");
+
+let args = program.args;
+args.unshift("--world-parameters", JSON.stringify(worldParameters));
+args.unshift("--require", process.cwd() + "/src/**/*.ts");
+args.unshift(
+  "--format",
+  process.env.CI || !process.stdout.isTTY ? "progress" : "progress-bar",
+);
+args.unshift("--format", "rerun:@rerun.txt");
+
+// Handle additional givens and undo actions
+// These are special and need to be loaded in seperately outside of the
+// World constructor so we cannot rely on passing them in the worldParameters.
+const additionalGivens =
+  options.additionalGivens ||
+  JSON.stringify({
+    v1: path.resolve(cwd, "features/v1/given.json"),
+    v2: path.resolve(cwd, "features/v2/given.json"),
+  });
+
+const undoActions = JSON.stringify({
+  v1: path.resolve(cwd, "features/v1/undo.json"),
+  v2: path.resolve(cwd, "features/v2/undo.json"),
+});
+
+if (additionalGivens.length > 0) {
+  process.env.BDD_RUNNER_ADDITIONAL_GIVENS = additionalGivens;
+}
+
+if (undoActions.length > 0) {
+  process.env.BDD_RUNNER_UNDO_ACTIONS = undoActions;
+}
+
+// Run Cucumber
+const cli = new Cli({
+  argv: args,
+  cwd: cwd,
+  stdout: process.stdout,
+  stderr: process.stderr,
+  env: process.env,
+});
+
+cli.run();