google-admin-sdk/mock.coffee

node.js library that wraps the Directory and Groups APIs in the Google Admin SDK

_ = require 'underscore'
sinon = require 'sinon'
admin_sdk = require "#{__dirname}"
{Readable} = require 'stream'
sanitize = require 'sanitize-arguments'
async = require 'async'
_.mixin require('underscore.deep')

module.exports =
  get_google_sandbox: (data, id_num = 100000000) ->
    sandbox = sinon.sandbox.create()

    admin_sdk.data = data
    admin_sdk.sandbox = sandbox
    admin_sdk.restore = -> sandbox.restore()

    generate_ou = (org_unit_path) ->
      ou =
        kind: "admin#directory#orgUnit"
        name: org_unit_path[1..]
        orgUnitPath: org_unit_path
        orgUnitId: "id:ou_id"
        parentOrgUnitPath: '/'
      return ou

    # fast lookup by email
    admin_sdk.refresh_map = ->
      admin_sdk.data_users_map = {}
      admin_sdk.data_orgunits_map = {}
      for i, user of admin_sdk.data?.users
        admin_sdk.data_users_map[user.primaryEmail.toLowerCase()] = user
      if admin_sdk.data?.orgunits?
        admin_sdk.data_orgunits_map[ou] = generate_ou(ou) for ou in admin_sdk.data.orgunits
    admin_sdk.refresh_map()

    # Currently, the mock library supports only this particular invocation of OrgUnitProvisioning.get
    sandbox.stub admin_sdk.OrgUnitProvisioning.prototype, 'get', (customer_id, org_unit_path, cb) =>
      # this method takes in org_unit_path without the leading slash, but our mock-db keys include the
      # leading slash, so append it
      existing_ou = admin_sdk.data_orgunits_map["/#{org_unit_path}"]
      return cb null, existing_ou if existing_ou?
      return cb
        error:
          errors: []
          code: 404,
          message: "Org unit not found"

    sandbox.stub admin_sdk.OrgUnitProvisioning.prototype, 'insert', (customer_id, properties, cb) =>
      parent = properties.parentOrgUnitPath
      name = properties.name
      full_path = if parent is '/' then "/#{name}" else "#{parent}/#{name}"
      if admin_sdk.data_orgunits_map[full_path]?
        err =
          error:
            errors: [ { domain: 'global', reason: 'invalid', message: 'Invalid Ou Id' } ]
            code: 400
            message: 'Invalid Ou Id'
        return cb err, null
      else
      admin_sdk.data.orgunits.push full_path
      response =
        kind: "admin#directory#orgUnit"
        name: properties.name
        orgUnitPath: full_path
        orgUnitId: "id:ou_id"
        parentOrgUnitPath: properties.parentOrgUnitPath
      admin_sdk.data_orgunits_map[full_path] = response
      return cb null, response

    sandbox.stub admin_sdk.UserProvisioning.prototype, 'insert', (body, fields, cb) =>
      if _(fields).isFunction()
        cb = fields

      q = exec: (cb_exec) =>
        email = body.primaryEmail.toLowerCase()
        if admin_sdk.data_users_map[email]?
          return cb_exec error: { code: 409, message: 'Entity already exists.' }
        generated_properties =
          hashFunction: 'SHA-1'
          orgUnitId: 'id:ou_id'
          kind: "admin#directory#user"
          id: "" + id_num++
          isAdmin: false
          isDelegatedAdmin: false
          isMailboxSetup: false
        ga_user = _.deepClone _.extend(body, generated_properties)
        admin_sdk.data.users[generated_properties.id] = ga_user
        admin_sdk.data_users_map[email] = ga_user
        cb_exec null, 200, _.omit(ga_user, 'password')
      return q unless cb?
      q.exec cb

    sandbox.stub admin_sdk.UserProvisioning.prototype, 'patch', (userkey, body, fields, cb) =>
      arglist = sanitize arguments, admin_sdk.UserProvisioning.patch, [String, Object, String, Function]
      args = _.object ['userkey', 'body', 'fields', 'cb'], arglist
      ###
      A PATCH to the Directory API to update a field whose value is an array will overwrite the array *except*
      in the case that the new value is an empty array. In this case, the value is unchanged. It's not clear
      if this undocumented behavior is intentional.
      ###
      for key, value of args.body
        admin_sdk.data.users[args.userkey][key] = _.deepClone value unless _.isEqual value, []
      if args.fields?
        args.cb null, _(admin_sdk.data.users[args.userkey]).pick fields
      else
        args.cb null, admin_sdk.data.users[args.userkey]

    sandbox.stub admin_sdk.UserProvisioning.prototype, 'get', (userkey, cb) =>
      q = exec: (cb_exec) =>
        if admin_sdk.data.users[userkey]? # user_id
          return cb_exec null, _.deepClone admin_sdk.data.users[userkey]
        if admin_sdk.data_users_map[userkey]? # email
          return cb_exec null, _.deepClone admin_sdk.data_users_map[userkey]
        err =
         error:
          errors: [domain: "global", reason: "notFound", message: "Resource Not Found: userKey"]
          code: 404
          message: "Resource Not Found: userKey"
        cb_exec err
      return q unless cb?
      q.exec cb

    sandbox.stub admin_sdk.Batch.prototype, 'go', (queries, cb) =>
      console.warn "Doing batch of #{queries.length}"
      async.map queries, ((query, cb_m) ->
        query.exec (err, status_code, result) ->
          cb_m err, { statusCode: status_code, body: result }
      ), cb

    # assumes the only function to make Queries is user/list
    sandbox.stub admin_sdk.GoogleQuery.Query.prototype, 'stream', () ->
      return new SimpleStream admin_sdk.data.users

    class SimpleStream extends Readable
      constructor: (@_data) ->
        @data = _(@_data).values()
        super { objectMode: true }
        @i = 0
      _read: () =>
        if @i > (@data.length - 1)
          @push null
          return
        data = _.deepClone @data[@i++]
        @push data

    admin_sdk