loopback-workspace/test/model-access-control.js

**⚠️ LoopBack 3 is in Maintenance LTS mode, only critical bugs and critical security fixes will be provided. (See [Module Long Term Support Policy](#module-long-term-support-policy) below.)**

// Copyright IBM Corp. 2014,2019. All Rights Reserved.
// Node module: loopback-workspace
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT

'use strict';

const app = require('../');
const ModelDefinition = app.models.ModelDefinition;
const ModelAccessControl = app.models.ModelAccessControl;
const TestDataBuilder = require('./helpers/test-data-builder');
const expect = require('chai').expect;
const support = require('../test/support');
const givenBasicWorkspace = support.givenBasicWorkspace;

describe('ModelAccessControl', function() {
  describe('ModelAccessControl.create()', function() {
    beforeEach(givenBasicWorkspace);

    it('should create an accessControl list item', function(done) {
      ModelDefinition.create({
        name: 'TestModel',
        facetName: 'common',
      }, function(err, model) {
        if (err) return done(err);
        model.accessControls.create({
          principalType: '$role',
          principalId: '$everyone',
          permission: 'ALLOW',
          accessType: '*',
        }, function(err) {
          if (err) return done(err);

          const configFile = model.getConfigFile();
          configFile.load(function() {
            expect(configFile.data.acls).to.eql([{
              accessType: '*',
              principalType: '$role',
              principalId: '$everyone',
              permission: 'ALLOW',
            }]);
            model.accessControls.create({
              principalType: '$role',
              principalId: '$custom',
              permission: 'DENY',
              accessType: '*',
            }, function(err) {
              if (err) return done(err);
              configFile.load(function(err) {
                if (err) return done(err);
                // eslint-disable-next-line no-unused-expressions
                expect(configFile.data.acls).to.exist;
                expect(configFile.data.acls).to.have.length(2);
                expectCorrectOrder(configFile.data.acls);
                // load from disk
                model.accessControls(function(err, acl) {
                  if (err) return done(err);
                  expectCorrectOrder(acl);
                  acl.forEach(function(item, index) {
                    expect(item.index).to.equal(index);
                  });
                  done();
                });
              });

              function expectCorrectOrder(acl) {
                const principalIds = acl.map(function(item) {
                  return item.principalId;
                });
                expect(principalIds).to.eql(['$everyone', '$custom']);
              }
            });
          });
        });
      });
    });
  });

  describe('ModelAccessControl.getAccessTypes(callback)', function() {
    it('Get the available access types.', function() {

    });
  });

  describe('ModelAccessControl.getPermissionTypes(callback)', function() {
    it('Get the available permission types.', function() {

    });
  });

  describe('ModelAccessControl.getPrincipalTypes(callback)', function() {
    it('Get the available principal types.', function() {

    });
  });
});