apigeelint/test/specs/FR001-checkFaultRuleCondition.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 = "FR001",
  debug = require("debug")(`apigeelint:${testID}`),
  path = require("node:path"),
  bl = require("../../lib/package/bundleLinter.js");

describe(`${testID} - check condition on FaultRules`, function () {
  const 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,
    itemsWithFR001Errors = 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();
        itemsWithFR001Errors = items.filter(
          (item) =>
            item.messages &&
            item.messages.length &&
            item.messages.find((m) => m.ruleId == testID),
        );
        cb();
      });
    } else {
      cb();
    }
  };

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

  it("should generate no errors or warnings for proxy endpoint1", () => {
    insure(() => {
      const proxyEp1Error = itemsWithFR001Errors.find((item) =>
        item.filePath.endsWith(
          path.normalize("/apiproxy/proxies/endpoint1.xml"),
        ),
      );
      const messages =
        proxyEp1Error &&
        proxyEp1Error.messages.filter((msg) => msg.ruleId == testID);
      assert.ok(!proxyEp1Error || messages.length == 0);
    });
  });

  it("should generate an error for proxy endpoint2", () => {
    insure(() => {
      const proxyEp2Error = itemsWithFR001Errors.find((item) =>
        item.filePath.endsWith(
          path.normalize("/apiproxy/proxies/endpoint2.xml"),
        ),
      );
      assert.ok(proxyEp2Error);
      const messages = proxyEp2Error.messages.filter(
        (msg) => msg.ruleId == testID,
      );
      assert.ok(messages);
      assert.equal(messages.length, 1);
      assert.ok(
        messages[0].message.indexOf(
          "a FaultRule other than the fallback (rule2) has no Condition or the Condition is empty",
        ) > 0,
      );
      assert.equal(messages[0].severity, 2);
    });
  });

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

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

  it("should generate an error for target2", () => {
    insure(() => {
      const targetEp2Error = itemsWithFR001Errors.find((item) =>
        item.filePath.endsWith(path.normalize("/apiproxy/targets/target2.xml")),
      );
      assert.ok(targetEp2Error);
      const messages = targetEp2Error.messages.filter(
        (msg) => msg.ruleId == testID,
      );
      assert.ok(messages);
      assert.equal(messages.length, 1);
      assert.equal(messages[0].severity, 2);
      assert.ok(
        messages[0].message.indexOf(
          "a FaultRule other than the fallback (rule1) has no Condition or the Condition is empty",
        ) > 0,
      );
    });
  });

  it("should generate no error or warning for target3", () => {
    insure(() => {
      const targetEp3Error = itemsWithFR001Errors.find((item) =>
        item.filePath.endsWith(path.normalize("/apiproxy/targets/target3.xml")),
      );
      const messages =
        targetEp3Error &&
        targetEp3Error.messages.filter((msg) => msg.ruleId == testID);
      assert.ok(!targetEp3Error || messages.length == 0);
    });
  });

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

      const 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);
    });
  });
});