auditjs/bin/Services/RequestHelpers.spec.js

Audit dependencies to identify known vulnerabilities and maintenance problems

"use strict";
/*
 * Copyright 2019-Present Sonatype Inc.
 *
 * 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
 *
 *     http://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.
 */
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const TestHelper_1 = __importDefault(require("../Tests/TestHelper"));
const RequestHelpers_1 = require("./RequestHelpers");
const os_1 = __importDefault(require("os"));
const pack = require('../../package.json');
describe('RequestHelpers', () => {
    it('should return a valid user agent from getUserAgent ', () => {
        const nodeVersion = process.versions;
        const environment = 'NodeJS';
        const environmentVersion = nodeVersion.node;
        const system = `${os_1.default.type()} ${os_1.default.release()}`;
        const res = RequestHelpers_1.RequestHelpers.getUserAgent();
        const expected = ['User-Agent', `AuditJS/${pack.version} (${environment} ${environmentVersion}; ${system})`];
        (0, TestHelper_1.default)(res).to.include.members(expected);
    });
    it('getAgent() should return undefined when no env variable is set', () => {
        process.env.http_proxy = 'no-proxy';
        const res = RequestHelpers_1.RequestHelpers.getAgent();
        (0, TestHelper_1.default)(res).to.be.undefined;
    });
    it('getAgent() should return a proxy httpAgent when env variable is set', () => {
        process.env.http_proxy = 'http://test.local:8080';
        const res = RequestHelpers_1.RequestHelpers.getAgent();
        (0, TestHelper_1.default)(res).not.to.be.undefined;
        if (res) {
            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
            // @ts-ignore
            (0, TestHelper_1.default)(res.proxy.hostname).to.equal('test.local');
            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
            // @ts-ignore
            (0, TestHelper_1.default)(res.proxy.port).to.equal('8080');
        }
    });
    it('getAgent() should return an insecure httpAgent', () => {
        const res = RequestHelpers_1.RequestHelpers.getAgent(true);
        (0, TestHelper_1.default)(res).not.to.be.undefined;
        if (res) {
            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
            // @ts-ignore
            (0, TestHelper_1.default)(res.options.rejectUnauthorized).to.equal(false);
        }
    });
    // TODO: This may indicate a problem. In the case of insecure, the proxy setting is ignored
    // see: https://github.com/sonatype-nexus-community/auditjs/pull/213#discussion_r545617666
    /*
    it('getAgent() should return an insecure proxy httpAgent when env variable is set', () => {
      // eslint-disable-next-line @typescript-eslint/camelcase
      process.env.http_proxy = 'http://test.local:8080';
      const res = RequestHelpers.getAgent(true);
      expect(res).not.to.be.undefined;
      if (res) {
        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
        // @ts-ignore
        expect(res.options.rejectUnauthorized).to.equal(false);
        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
        // @ts-ignore
        expect(res.proxy.host).to.equal('test.local');
        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
        // @ts-ignore
        expect(res.proxy.port).to.equal(8080);
      }
    });
    */
    it('should return an httpAgent when env variable is set', () => {
        process.env.http_proxy = 'http://test.local:8080';
        const res = RequestHelpers_1.RequestHelpers.getHttpAgent();
        (0, TestHelper_1.default)(res).not.to.be.undefined;
        if (res) {
            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
            // @ts-ignore
            (0, TestHelper_1.default)(res.proxy.hostname).to.equal('test.local');
            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
            // @ts-ignore
            (0, TestHelper_1.default)(res.proxy.port).to.equal('8080');
        }
    });
    it('should return undefined when no env variable is set', () => {
        process.env.http_proxy = 'no-proxy';
        const res = RequestHelpers_1.RequestHelpers.getHttpAgent();
        (0, TestHelper_1.default)(res).to.be.undefined;
    });
});
//# sourceMappingURL=RequestHelpers.spec.js.map