apigeelint/test/specs/PO026-profile.js

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

/*
  Copyright © 2019-2026 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"),
  path = require("node:path"),
  debug = require("debug")("apigeelint:PO026-test"),
  bl = require("../../lib/package/bundleLinter.js");

const propertySetRefTest = (profile) => () => {
  const configuration = {
    debug: true,
    source: {
      type: "filesystem",
      path: path.resolve(
        __dirname,
        "../fixtures/resources/PO026-apigeex-proxy/apiproxy",
      ),
      bundleType: "apiproxy",
    },
    excluded: {},
    setExitCode: false,
    output: () => {}, // suppress output
    profile,
  };
  const expectedCount = profile == "apigee" ? 8 : 0;

  bl.lint(configuration, (bundle) => {
    const items = bundle.getReport();
    assert.ok(items);
    assert.ok(items.length);
    let itemsSeen = 0;
    items.forEach((item) => {
      if (
        item.filePath.endsWith(
          path.normalize("/apiproxy/policies/AM-config-properties.xml"),
        )
      ) {
        itemsSeen++;
        debug(item);
        assert.equal(item.errorCount, expectedCount);
      }
    });
    assert.equal(itemsSeen, 1);
  });
};

describe(`PO026 - PropertySetRef with various profiles`, function () {
  this.timeout(7000);
  it(
    `should NOT generate errors with profile 'apigeex'`,
    propertySetRefTest("apigeex"),
  );
  it(
    `should generate errors with profile 'apigee'`,
    propertySetRefTest("apigee"),
  );
});

const testID = "PO026",
  Policy = require("../../lib/package/Policy.js"),
  Dom = require("@xmldom/xmldom").DOMParser,
  fs = require("node:fs"),
  plugin = require(bl.resolvePlugin(testID));

const po026Test = (filename, profile, cb) => {
  it(`should correctly process ${filename} for profile ${profile}`, () => {
    const baseDir = path.resolve(
        __dirname,
        "../fixtures/resources/PO026-assignVariable-policies",
      ),
      fqfname = path.resolve(baseDir, filename),
      policyXml = fs.readFileSync(fqfname, "utf-8"),
      doc = new Dom().parseFromString(policyXml),
      p = new Policy(baseDir, filename, this, doc),
      bundle = { profile };

    p.getElement = () => doc.documentElement;
    p.getBundle = () => bundle;

    plugin.onPolicy(p, (e, foundIssues) => {
      assert.equal(e, undefined, "should be undefined");
      cb(p, foundIssues);
    });
  });
};

describe(`PO026 - AssignVariable with ResourceURL`, () => {
  po026Test(`ResourceUrl.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, false);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      0,
      JSON.stringify(p.getReport().messages),
    );
  });

  po026Test(`ResourceUrl.xml`, "apigee", (p, foundIssues) => {
    assert.equal(foundIssues, true);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(p.getReport().messages.length, 2);
    assert.ok(p.getReport().messages[0].message.indexOf("stray element") > 0);
    assert.ok(
      p
        .getReport()
        .messages[1].message.indexOf("You should have at least one of") >= 0,
    );
  });
});

describe(`PO026 - AssignVariable with PropertySetRef`, () => {
  po026Test(`PropertySetRef-1.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, false);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      0,
      JSON.stringify(p.getReport().messages),
    );
    debug(p.getReport().messages);
  });

  po026Test(`PropertySetRef-2.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, true);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      1,
      JSON.stringify(p.getReport().messages),
    );
    debug(p.getReport().messages);
  });

  po026Test(`PropertySetRef-3.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, false);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      0,
      JSON.stringify(p.getReport().messages),
    );
    debug(p.getReport().messages);
  });

  po026Test(`PropertySetRef-4.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, true);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      1,
      JSON.stringify(p.getReport().messages),
    );
    debug(p.getReport().messages);
  });

  po026Test(`PropertySetRef-5.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, false);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      0,
      JSON.stringify(p.getReport().messages),
    );
    debug(p.getReport().messages);
  });

  po026Test(`PropertySetRef-6.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, false);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      0,
      JSON.stringify(p.getReport().messages),
    );
    debug(p.getReport().messages);
  });

  po026Test(`PropertySetRef-7.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, true);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      1,
      JSON.stringify(p.getReport().messages),
    );
    debug(p.getReport().messages);
  });

  po026Test(`PropertySetRef-8.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, false);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      0,
      JSON.stringify(p.getReport().messages),
    );
  });
});

describe(`PO026 - AssignVariable with Template`, () => {
  po026Test(`Template-1.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, false);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      0,
      JSON.stringify(p.getReport().messages),
    );
  });

  po026Test(`Template-2.xml`, "apigeex", (p, foundIssues) => {
    assert.equal(foundIssues, true);
    assert.ok(p.getReport().messages, "messages undefined");
    assert.equal(
      p.getReport().messages.length,
      1,
      JSON.stringify(p.getReport().messages),
    );
  });
});