apigeelint/test/specs/FR003.js

Node module and tool to lint a bundle for an Apigee API Proxy or sharedflow.

/*
  Copyright 2019-2025 Google LLC

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      https://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/

/* global describe, it */
const assert = require("node:assert"),
  testID = "FR003",
  debug = require("debug")(`apigeelint:${testID}`),
  path = require("node:path"),
  Bundle = require("../../lib/package/Bundle.js"),
  bl = require("../../lib/package/bundleLinter.js");

describe(`${testID} - check for single FaultRule`, function () {
  let configuration = {
    debug: true,
    source: {
      type: "filesystem",
      path: path.resolve(__dirname, "../fixtures/resources/FR-checks/apiproxy"),
      bundleType: "apiproxy",
    },
    profile: "apigee",
    excluded: {},
    setExitCode: false,
    output: () => {}, // suppress output
  };
  let items = null,
    itemsWithFR003Errors = null;

  /*
   * Tests must not run the linter outside of the scope of an it() ,
   * because then the mocha --grep does not do what you want.
   * This method insures we run the lint once, but only within
   * the scope of it().
   **/
  const insure = (cb) => {
    if (items == null) {
      debug("test configuration: " + JSON.stringify(configuration));
      bl.lint(configuration, (bundle) => {
        items = bundle.getReport();
        itemsWithFR003Errors = items.filter(
          (item) =>
            item.messages &&
            item.messages.length &&
            item.messages.find((m) => m.ruleId == testID),
        );
        cb();
      });
    } else {
      cb();
    }
  };

  it("should generate the expected warnings", () => {
    insure(() => {
      assert.ok(items);
      assert.ok(items.length);
      assert.equal(itemsWithFR003Errors.length, 2);
    });
  });

  it("should generate a warning for proxy endpoint1", () => {
    insure(() => {
      let proxyEp1Error = itemsWithFR003Errors.find((item) =>
        item.filePath.endsWith(
          path.normalize("/apiproxy/proxies/endpoint1.xml"),
        ),
      );
      assert.ok(proxyEp1Error);

      let messages = proxyEp1Error.messages.filter(
        (msg) => msg.ruleId == testID,
      );
      assert.ok(messages);
      assert.equal(messages.length, 1);
      assert.ok(
        messages[0].message.indexOf("Consider migrating to DefaultFaultRule") >
          0,
      );
      assert.equal(messages[0].severity, 1);
    });
  });

  it("should generate an error for proxy endpoint2", () => {
    insure(() => {
      let proxyEp2Error = itemsWithFR003Errors.find((item) =>
        item.filePath.endsWith(
          path.normalize("/apiproxy/proxies/endpoint2.xml"),
        ),
      );
      let messages =
        proxyEp2Error &&
        proxyEp2Error.messages.filter((msg) => msg.ruleId == testID);
      assert.ok(!proxyEp2Error || messages.length == 0);
    });
  });

  it("should generate no error for proxy endpoint3", () => {
    insure(() => {
      let proxyEp3Error = itemsWithFR003Errors.find((item) =>
        item.filePath.endsWith(
          path.normalize("/apiproxy/proxies/endpoint3.xml"),
        ),
      );
      assert.ok(!proxyEp3Error);
    });
  });

  it("should generate no error for target1", () => {
    insure(() => {
      let targetEp1Error = itemsWithFR003Errors.find((item) =>
        item.filePath.endsWith(path.normalize("/apiproxy/targets/target1.xml")),
      );
      let messages =
        targetEp1Error &&
        targetEp1Error.messages.filter((msg) => msg.ruleId == testID);
      assert.ok(!targetEp1Error || messages.length == 0);
    });
  });

  it("should generate no error for target2", () => {
    insure(() => {
      let targetEp2Error = itemsWithFR003Errors.find((item) =>
        item.filePath.endsWith(path.normalize("/apiproxy/targets/target2.xml")),
      );
      let messages =
        targetEp2Error &&
        targetEp2Error.messages.filter((msg) => msg.ruleId == testID);
      assert.ok(!targetEp2Error || messages.length == 0);
    });
  });

  it("should generate a warning for target3", () => {
    insure(() => {
      let targetEp3Error = itemsWithFR003Errors.find((item) =>
        item.filePath.endsWith(path.normalize("/apiproxy/targets/target3.xml")),
      );
      assert.ok(targetEp3Error);
      let messages = targetEp3Error.messages.filter(
        (msg) => msg.ruleId == testID,
      );
      assert.ok(messages);
      assert.equal(messages.length, 1);
      assert.equal(messages[0].severity, 1);
      assert.equal(
        messages[0].message.indexOf(
          "Just one FaultRule and no Condition. Consider migrating to DefaultFaultRule",
        ),
        0,
      );
    });
  });

  // generate a full report and check the format of the report
  it("should create a report object with valid schema", function () {
    insure(() => {
      let formatter = bl.getFormatter("json.js");

      if (!formatter) {
        assert.fail("formatter implementation not defined");
      }
      let schema = require("./../fixtures/reportSchema.js"),
        Validator = require("jsonschema").Validator,
        v = new Validator(),
        jsonReport = JSON.parse(formatter(items)),
        validationResult = v.validate(jsonReport, schema);

      assert.equal(validationResult.errors.length, 0, validationResult.errors);
    });
  });
});