apigeelint/test/specs/CC001-CheckConditionForLiterals.js

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

/*
  Copyright 2019-2023,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 it, describe */

const assert = require("node:assert"),
  testID = "CC001",
  debug = require("debug")("apigeelint:" + testID),
  bl = require("../../lib/package/bundleLinter.js"),
  Condition = require("../../lib/package/Condition.js"),
  plugin = require(bl.resolvePlugin(testID)),
  Dom = require("@xmldom/xmldom").DOMParser,
  test = function (exp, expected) {
    it(`tests whether exp(${exp}) includes a literal, expect(${expected})`, function () {
      const doc = new Dom().parseFromString(exp),
        c = new Condition(doc, this);

      c.addMessage = function (msg) {
        debug(msg);
      };

      plugin.onCondition(c, function (e, result) {
        assert.equal(e, undefined, e ? " error " : " no error");
        assert.equal(
          result,
          expected,
          result ? " literal found " : "literal not found",
        );
      });
    });
  };

//now generate a full report and check the format of the report

describe(`${testID} - ${plugin.plugin.name}`, function () {
  test("false", true);
  test("true", true);
  test("true OR false", true);
  test("b=1", false);
  test("b = c AND true", true);
  test("true and b!=c", true);
  test("b!=true", false);
  test("b=false", false);
  test('request.header.Content-Type = "application/json"', false);
  test(
    'request.verb = "POST" and request.header.Content-Type = "application/json"',
    false,
  );
  // the newlines in the following condition are important
  test(
    `request.header.content-type != "text/xml" AND
          request.header.content-type != "application/xml`,
    false,
  );
});

describe(`${testID} - Print plugin results`, function () {
  it("should create a report object with valid schema", function () {
    debug("test configuration: " + JSON.stringify(configuration));
    const Bundle = require("../../lib/package/Bundle.js"),
      bundle = new Bundle(configuration);
    bl.executePlugin(testID, bundle);
    const report = bundle.getReport();

    const formatter = bl.getFormatter("json.js");
    if (!formatter) {
      assert.fail("formatter implementation not defined");
    }
    const schema = require("./../fixtures/reportSchema.js"),
      Validator = require("jsonschema").Validator,
      v = new Validator(),
      jsonReport = JSON.parse(formatter(report)),
      validationResult = v.validate(jsonReport, schema);
    assert.equal(validationResult.errors.length, 0, validationResult.errors);
  });
});