arangodb/js/common/tests/shell-foxx-manager-install-spec.js

/*jshint globalstrict:false, strict:false */
/*global describe, beforeEach, afterEach, it, expect*/

////////////////////////////////////////////////////////////////////////////////
/// @brief Spec for foxx manager
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Michael Hackstein
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

'use strict';

var FoxxManager = require("@arangodb/foxx/manager");
var arangodb = require("@arangodb");
var ArangoError = arangodb.ArangoError;
var fs = require("fs");
var Module = require('module');
var errors = require("internal").errors;
var internal = require('internal');
var basePath = fs.makeAbsolute(fs.join(internal.startupPath, "common", "test-data", "apps"));

function validateError(type, error) {
  expect(error instanceof ArangoError).toBeTruthy();
  expect(error.errorNum).toEqual(
    type.code,
    "Invalid code returned: expected " + type.code + " got " + error.errorNum
    + " Message: " + error
    + " Trace: " + error.stack
  );
}

describe("Foxx Manager install", function() {
  beforeEach(function() {
    try {
      FoxxManager.uninstall("/unittest/broken");
    } catch(e) {
      try {
        // Make sure that the files are physically removed
        var appPath = fs.makeAbsolute(Module._appPath);
        appPath = fs.join(appPath, "unittest", "broken");
        fs.removeDirectoryRecursive(appPath, true);
      } catch(err) {
      }
    }
  });

  describe("failing for an invalid app", function() {
    beforeEach(function() {
      try {
        FoxxManager.uninstall("/unittest/broken", {force: true});
      } catch(e) {}
    });

    afterEach(function() {
      try {
        FoxxManager.uninstall("/unittest/broken");
      } catch(e) {}
    });

    it("without manifest", function() {
      try {
        FoxxManager.install(fs.join(basePath, "no-manifest"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_FILE_NOT_FOUND, e);
      }
    });

    it("with malformed manifest", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-manifest"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_MALFORMED_MANIFEST_FILE, e);
      }
    });

    it("with incomplete manifest", function() {
      try {
        FoxxManager.install(fs.join(basePath, "incomplete-manifest"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_INVALID_APPLICATION_MANIFEST, e);
      }
    });

    it("with malformed name", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-name"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_INVALID_APPLICATION_MANIFEST, e);
      }
    });

    it("with malformed controller file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-controller-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_FAILED_TO_EXECUTE_SCRIPT, e);
      }
    });

    it("with malformed controller path", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-controller-name"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_INVALID_APPLICATION_MANIFEST, e);
      }
    });

    it("with malformed controller path", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-controller-path"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_SYS_ERROR, e);
      }
    });

    it("with broken controller file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "broken-controller-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_FAILED_TO_EXECUTE_SCRIPT, e);
      }
    });

    it("with broken exports file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "broken-exports-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_FAILED_TO_EXECUTE_SCRIPT, e);
      }
    });

    it("with broken setup file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "broken-setup-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_FAILED_TO_EXECUTE_SCRIPT, e);
      }
    });

    it("with malformed exports file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-exports-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_FAILED_TO_EXECUTE_SCRIPT, e);
      }
    });

    it("with malformed exports path", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-exports-path"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_SYS_ERROR, e);
      }
    });

    it("with malformed setup file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-setup-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_FAILED_TO_EXECUTE_SCRIPT, e);
      }
    });

    it("with malformed setup path", function() {
      try {
        FoxxManager.install(fs.join(basePath, "malformed-setup-path"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_SYS_ERROR, e);
      }
    });

    it("with missing controller file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "missing-controller-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_SYS_ERROR, e);
      }
    });

    it("with missing exports file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "missing-exports-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_SYS_ERROR, e);
      }
    });

    it("with missing setup file", function() {
      try {
        FoxxManager.install(fs.join(basePath, "missing-setup-file"), "/unittest/broken");
        expect(true).toBeFalsy("Managed to install broken application");
      } catch(e) {
        validateError(errors.ERROR_SYS_ERROR, e);
      }
    });
  });

  describe("success with", function() {
    it("a minimal app", function() {
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), "/unittest/broken");
      } catch(e) {
        expect(true).toBeFalsy("Could not install a minimal valid app.");
      }
      FoxxManager.uninstall("/unittest/broken", {force: true});
    });

    it("an app containing a sub-folder 'app'", function() {
      try {
        FoxxManager.install(fs.join(basePath, "interior-app-path"), "/unittest/broken");
      } catch(e) {
        expect(true).toBeFalsy("Could not install an app with sub-folder 'app'.");
      }
      FoxxManager.uninstall("/unittest/broken", {force: true});
    });
  });

  describe("should not install on invalid mountpoint", function() {
    it("starting with _", function() {
      var mount = "/_disallowed";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });

    it("starting with %", function() {
      var mount = "/%disallowed";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });

    it("starting with a number", function() {
      var mount = "/3disallowed";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });

    it("starting with app/", function() {
      var mount = "/app";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });

    it("containing /app/", function() {
      var mount = "/unittest/app/test";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });

    it("containing a .", function() {
      var mount = "/dis.allowed";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });

    it("containing a whitespace", function() {
      var mount = "/disal lowed";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });

    it("starting with ?", function() {
      var mount = "/disal?lowed";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });

    it("starting with :", function() {
      var mount = "/disa:llowed";
      try {
        FoxxManager.install(fs.join(basePath, "minimal-working-manifest"), mount);
        expect(true).toBeFalsy("Installed app at invalid mountpoint.");
        FoxxManager.uninstall(mount);
      } catch(e) {
        validateError(errors.ERROR_INVALID_MOUNTPOINT, e);
      }
    });
  });

  it("checking marvelous comments", function() {
    var mount = "/unittest/comments";
    try {
      FoxxManager.uninstall(mount, {force: true});
    } catch (e) {
      expect(e).toBeUndefined();
    }
    try {
      FoxxManager.install(fs.join(basePath, "fanciful-comments"), mount);
      expect(true).toBeTruthy();
    } catch (e) {
      expect(true).toBeFalsy("Failed to install app with comments.");
      expect(e).toBeUndefined();
    }
    try {
      FoxxManager.uninstall(mount, {force: true});
    } catch (e) {
      expect(e).toBeUndefined();
    }
  });
});