js-generator-openstack/spec/app/lib/component/gerrit.js

/*
 * Copyright (c) 2016 Hewlett Packard Enterprise Development Company, LP
 *
 * 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.
 */

'use strict';

var libDir = '../../../../generators/app/lib';

var ini = require('ini');

var gerrit = require(libDir + '/component/gerrit');
var projectBuilder = require(libDir + '/project_builder');
var pkgBuilder = require(libDir + '/pkg_builder');
var mocks = require('../../../helpers/mocks');

var iniFile = {
  gerrit: {
    host: 'review.example.org',
    port: '1000',
    project: 'openstack/test-project.git'
  }
};

/**
 * Assert that the gerrit file content matches the passed structure.
 *
 * @param {object} content The expected data structure.
 * @returns {void}
 */
function expectGerritFileContent (content) {
  var files = projectBuilder.getIncludedFiles();

  // get the .gitreview file
  var gitreview = null;
  files.forEach(function (fileRef) {
    if (fileRef.to === '.gitreview') {
      gitreview = ini.parse(fileRef.content());
    }
  });

  // Test the content
  expect(gitreview).toBeTruthy();
  expect(gitreview).toEqual(content);
}

describe('generator-openstack:lib/component/gerrit', function () {

  beforeEach(function () {
    projectBuilder.clear();
  });

  afterEach(function () {
    pkgBuilder.fromJSON(JSON.stringify({}));
  });

  describe('api', function () {
    it('should define init, prompt, and configure',
      function () {
        expect(typeof gerrit.init).toBe('function');
        expect(typeof gerrit.prompt).toBe('function');
        expect(typeof gerrit.configure).toBe('function');
      });
  });

  describe('runtime', function () {
    it('should not create a new file if one does not exist already.',
      function () {
        // No answers, non-interactive run.
        var mockAnswers = {};
        var generator = mocks.buildGenerator(null, mockAnswers);
        generator.fs.delete('.gitreview');

        gerrit.init(generator);
        gerrit.prompt(generator);
        gerrit.configure(generator);

        expect(generator.fs.exists('.gitreview')).toBeFalsy();
      });

    it('should not delete a file if one exists.',
      function () {
        // No answers, non-interactive run.
        var mockAnswers = {};
        var generator = mocks.buildGenerator(null, mockAnswers);
        generator.fs.write('.gitreview', ini.stringify(iniFile));

        // Set defaults
        gerrit.init(generator);
        gerrit.prompt(generator);
        gerrit.configure(generator);

        expect(generator.fs.exists('.gitreview')).toBeTruthy();
      });

    it('should write default values if a new file is requested.',
      function () {
        // No answers, non-interactive run.
        var mockAnswers = {enableGerrit: true};
        var generator = mocks.buildGenerator(null, mockAnswers);
        pkgBuilder.fromJSON(JSON.stringify({name: 'generator-openstack'}));

        generator.fs.delete('.gitreview');

        // Set defaults
        gerrit.init(generator);
        gerrit.prompt(generator);
        gerrit.configure(generator);

        expectGerritFileContent({
          gerrit: {
            host: 'review.openstack.org',
            port: '29418',
            project: 'openstack/generator-openstack.git'
          }
        });
      });

    it('should read the default project name from the package builder.',
      function () {
        // No answers, non-interactive run.
        var mockAnswers = {enableGerrit: true};
        pkgBuilder.fromJSON(JSON.stringify({name: 'foo'}));

        var generator = mocks.buildGenerator(null, mockAnswers);
        generator.fs.delete('.gitreview');

        // Set defaults
        gerrit.init(generator);
        gerrit.prompt(generator);
        gerrit.configure(generator);

        expectGerritFileContent({
          gerrit: {
            host: 'review.openstack.org',
            port: '29418',
            project: 'openstack/foo.git'
          }
        });
      });
  });

  describe('init()', function () {
    it('should return a generator',
      function () {
        var generator = mocks.buildGenerator();
        var outputGenerator = gerrit.init(generator);
        expect(outputGenerator).toEqual(generator);
      });
  });

  describe('prompt()', function () {
    it('should return a promise that resolves with a generator',
      function () {
        var generator = mocks.buildGenerator();
        var outputPromise = gerrit.prompt(generator);
        outputPromise.then(function (outputGenerator) {
          expect(outputGenerator).toEqual(generator);
        });
      });

    it('should not show a prompt if non-interactive is set',
      function () {
        var generator = mocks.buildGenerator(null, null,
          {'non-interactive': true});
        var promptSpy = spyOn(generator, 'prompt');

        generator.fs.write('.gitreview', ini.stringify(iniFile));

        gerrit.init(generator);
        gerrit.prompt(generator);

        expect(promptSpy.calls.any()).toBeFalsy();
      });

    it('should use defaults in .gitreview if no answers provided',
      function () {
        var generator = mocks.buildGenerator();

        generator.fs.write('.gitreview', ini.stringify(iniFile));
        gerrit.init(generator);
        gerrit.prompt(generator);
        gerrit.configure(generator);
        expectGerritFileContent(iniFile);
      });

    it('should configure answers if answers provided',
      function () {
        var config = {};
        var mockAnswers = {
          enableGerrit: true,
          gerritHost: 'review.example.org',
          gerritPort: '1000',
          gerritProject: 'openstack/test.git'
        };
        var generator = mocks.buildGenerator(config, mockAnswers);

        // Set defaults
        gerrit.init(generator);
        gerrit.prompt(generator);
        gerrit.configure(generator);

        expectGerritFileContent({
          gerrit: {
            host: mockAnswers.gerritHost,
            port: mockAnswers.gerritPort,
            project: mockAnswers.gerritProject
          }
        });
      });
  });

  describe('configure()', function () {
    it('should return a generator',
      function () {
        var generator = mocks.buildGenerator();
        var outputGenerator = gerrit.init(generator);
        expect(outputGenerator).toEqual(generator);
      });

    it('should create a .gitreview file if enabled',
      function () {
        var generator = mocks.buildGenerator(null, {enableGerrit: true});
        pkgBuilder.fromJSON(JSON.stringify({name: 'generator-openstack'}));

        // Make sure we don't have something left over from another test.
        generator.fs.delete('.gitreview');

        gerrit.init(generator);
        gerrit.prompt(generator);
        gerrit.configure(generator);

        expectGerritFileContent({
          gerrit: {
            host: 'review.openstack.org',
            port: '29418',
            project: 'openstack/generator-openstack.git'
          }
        });

        var excludedFiles = projectBuilder.getExcludedFiles();
        expect(excludedFiles.length).toBe(0);
      });

    it('should delete a .gitreview file if disabled',
      function () {
        var generator = mocks.buildGenerator(null, {enableGerrit: false});

        gerrit.init(generator);
        gerrit.prompt(generator);
        gerrit.configure(generator);

        var includedFiles = projectBuilder.getIncludedFiles();
        expect(includedFiles.length).toBe(0);

        var excludedFiles = projectBuilder.getExcludedFiles();
        expect(excludedFiles.length).toBe(1);
        expect(excludedFiles[0]).toBe('.gitreview');
      });
  });
});