openhim-core

should = require "should" request = require "supertest" server = require "../../lib/server" tcpAdapter = require "../../lib/tcpAdapter" polling = require "../../lib/polling" Channel = require("../../lib/model/channels").Channel Transaction = require("../../lib/model/transactions").Transaction testUtils = require "../testUtils" auth = require("../testUtils").auth sinon = require "sinon" describe "API Integration Tests", -> describe 'Channels REST Api testing', -> channel1 = { name: "TestChannel1" urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true ] txViewAcl: "aGroup" } channel2 = { name: "TestChannel2" urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true ] txViewAcl: "group1" } authDetails = {} before (done) -> auth.setupTestUsers (err) -> return done err if err server.start apiPort: 8080, tcpHttpReceiverPort: 7787, -> authDetails = auth.getAuthDetails() done() after (done) -> Transaction.remove {}, -> Channel.remove {}, -> server.stop -> auth.cleanupTestUsers -> done() beforeEach (done) -> Transaction.remove {}, -> Channel.remove {}, -> (new Channel channel1).save (err, ch1) -> channel1._id = ch1._id (new Channel channel2).save (err, ch2) -> channel2._id = ch2._id done() describe '*getChannels()', -> it 'should fetch all channels', (done) -> request("https://localhost:8080") .get("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(200) .end (err, res) -> if err done err else res.body.length.should.be.eql 2 done() it 'should only allow non root user to fetch channel that they are allowed to view', (done) -> request("https://localhost:8080") .get("/channels") .set("auth-username", testUtils.nonRootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(200) .end (err, res) -> if err done err else res.body.length.should.be.eql 1 res.body[0].name.should.be.eql 'TestChannel2' done() describe '*addChannel()', -> it 'should add a new channel', (done) -> newChannel = name: "NewChannel" urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true ] request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(newChannel) .expect(201) .end (err, res) -> if err done err else Channel.findOne { name: "NewChannel" }, (err, channel) -> channel.should.have.property "urlPattern", "test/sample" channel.allow.should.have.length 3 done() it 'should reject a channel without a name', (done) -> newChannel = urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true ] request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(newChannel) .expect(400) .end (err, res) -> if err done err else done() it 'should reject invalid channels with invalid pathTransform', (done) -> invalidChannel = name: "InvalidChannel" urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ name: "test route" host: "localhost" pathTransform: "invalid" port: 9876 primary: true ] request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(invalidChannel) .expect(400) .end (err, res) -> if err done err else done() it 'should reject channels containing both path and pathTransform', (done) -> invalidChannel = name: "InvalidChannel" urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ name: "test route" host: "localhost" path: "/target" pathTransform: "s/foo/bar" port: 9876 primary: true ] request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(invalidChannel) .expect(400) .end (err, res) -> if err done err else done() it 'should not allow a non admin user to add a channel', (done) -> newChannel = {} request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.nonRootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(newChannel) .expect(403) .end (err, res) -> if err done err else done() it 'should notify master to startup TCP server if the new channel is of type "tcp"', (done) -> tcpChannel = name: "TCPTestChannel-Add" urlPattern: "/" allow: [ 'tcp' ] type: 'tcp' tcpHost: '0.0.0.0' tcpPort: 3600 routes: [ name: "TcpRoute" host: "localhost" port: 9876 primary: true type: "tcp" ] stub = sinon.stub tcpAdapter, 'notifyMasterToStartTCPServer' request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(tcpChannel) .expect(201) .end (err, res) -> if err done err else stub.should.be.calledOnce stub.restore() done() it 'should NOT notify master to startup TCP server if the new channel is of type "tcp" but is disabled', (done) -> tcpChannelDisabled = name: "TCPTestChannel-Add-Disabled" urlPattern: "/" allow: [ 'tcp' ] type: 'tcp' tcpHost: '0.0.0.0' tcpPort: 3601 routes: [ name: "TcpRoute" host: "localhost" port: 9876 primary: true type: "tcp" ] status: 'disabled' stub = sinon.stub tcpAdapter, 'notifyMasterToStartTCPServer' request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(tcpChannelDisabled) .expect(201) .end (err, res) -> if err done err else stub.should.not.be.called stub.restore() done() it 'should register the channel with the polling service if of type "polling"', (done) -> pollChannel = name: "POLLINGTestChannel-Add" urlPattern: "/trigger" allow: [ 'polling' ] type: 'polling' pollingSchedule: '5 * * * *' routes: [ name: "PollRoute" host: "localhost" port: 9876 primary: true ] spy = sinon.spy polling, 'registerPollingChannel' request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(pollChannel) .expect(201) .end (err, res) -> spy.restore() if err done err else spy.calledOnce.should.be.true spy.getCall(0).args[0].should.have.property 'name', 'POLLINGTestChannel-Add' spy.getCall(0).args[0].should.have.property 'urlPattern', '/trigger' spy.getCall(0).args[0].should.have.property 'type', 'polling' done() it 'should NOT register the channel with the polling service if of type "polling" but is disabled', (done) -> pollChannelDisabled = name: "POLLINGTestChannel-Add-Disabled" urlPattern: "/trigger" allow: [ 'polling' ] type: 'polling' pollingSchedule: '5 * * * *' routes: [ name: "PollRoute" host: "localhost" port: 9876 primary: true ] status: 'disabled' spy = sinon.spy polling, 'registerPollingChannel' request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(pollChannelDisabled) .expect(201) .end (err, res) -> spy.restore() if err done err else spy.callCount.should.be.exactly 0 done() it 'should reject a channel without a primary route', (done) -> newChannel = name: 'no-primary-route-test' urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ name: "test route" host: "localhost" port: 9876 ] request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(newChannel) .expect(400) .end (err, res) -> if err done err else done() it 'should reject a channel with multiple primary routes', (done) -> newChannel = name: 'mulitple-primary-route-test' urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ { name: "test route" host: "localhost" port: 9876 primary: true }, { name: "test route 2" host: "localhost" port: 9877 primary: true } ] request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(newChannel) .expect(400) .end (err, res) -> if err done err else done() it 'should accept a channel with one enabled primary route but multiple disabled primary routes', (done) -> newChannel = name: 'disabled-primary-route-test' urlPattern: "test/sample" allow: [ "PoC", "Test1", "Test2" ] routes: [ { name: "test route" host: "localhost" port: 9876 primary: true }, { name: "test route 2" host: "localhost" port: 9877 primary: true status: 'disabled' } ] request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(newChannel) .expect(201) .end (err, res) -> if err done err else done() it 'should reject a channel with a priority below 1', (done) -> newChannel = name: "Channel-Priority--1" urlPattern: "test/sample" priority: -1 allow: [ "PoC", "Test1", "Test2" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true ] request("https://localhost:8080") .post("/channels") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(newChannel) .expect(400) .end (err, res) -> if err done err else done() describe '*getChannel(channelId)', -> it 'should fetch a specific channel by id', (done) -> request("https://localhost:8080") .get("/channels/" + channel1._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(200) .end (err, res) -> if err done err else res.body.should.have.property "name", "TestChannel1" res.body.should.have.property "urlPattern", "test/sample" res.body.allow.should.have.length 3 done() it 'should not allow a non admin user from fetching a channel they dont have access to by name', (done) -> request("https://localhost:8080") .get("/channels/" + channel1._id) .set("auth-username", testUtils.nonRootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(403) .end (err, res) -> if err done err else done() it 'should allow a non admin user to fetch a channel they have access to by name', (done) -> request("https://localhost:8080") .get("/channels/" + channel2._id) .set("auth-username", testUtils.nonRootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(200) .end (err, res) -> if err done err else res.body.should.have.property "name", "TestChannel2" res.body.should.have.property "urlPattern", "test/sample" res.body.allow.should.have.length 3 done() it 'should return a 404 if that channel doesnt exist', (done) -> request("https://localhost:8080") .get("/channels/999999999999999999999999") .set("auth-username", testUtils.nonRootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(404) .end (err, res) -> if err done err else done() describe '*updateChannel(channelId)', -> it 'should update a specific channel by id', (done) -> updates = _id: "thisShouldBeIgnored" urlPattern: "test/changed" allow: [ "PoC", "Test1", "Test2", "another" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true , name: "test route2" host: "localhost" port: 8899 ] request("https://localhost:8080") .put("/channels/" + channel1._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(updates) .expect(200) .end (err, res) -> if err done err else Channel.findOne { name: "TestChannel1" }, (err, channel) -> channel.should.have.property "name", "TestChannel1" channel.should.have.property "urlPattern", "test/changed" channel.allow.should.have.length 4 channel.routes.should.have.length 2 done() it 'should not allow a non admin user to update a channel', (done) -> updates = {} request("https://localhost:8080") .put("/channels/" + channel1._id) .set("auth-username", testUtils.nonRootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(updates) .expect(403) .end (err, res) -> if err done err else done() it 'should notify master to startup a TCP server if the type is set to "tcp"', (done) -> httpChannel = new Channel name: "TestChannelForTCPUpdate" urlPattern: "/" allow: [ "test" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true ] txViewAcl: "group1" changeToTCP = { type: 'tcp' tcpHost: '0.0.0.0' tcpPort: 3601 } stub = sinon.stub tcpAdapter, 'notifyMasterToStartTCPServer' httpChannel.save -> request("https://localhost:8080") .put("/channels/" + httpChannel._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(changeToTCP) .expect(200) .end (err, res) -> if err done err else stub.should.be.calledOnce stub.restore() done() it 'should NOT notify master to startup a TCP server if the type is set to "tcp" but it is disabled', (done) -> httpChannel = new Channel name: "TestChannelForTCPUpdate-Disabled" urlPattern: "/" allow: [ "test" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true ] txViewAcl: "group1" changeToTCPDisabled = { type: 'tcp' tcpHost: '0.0.0.0' tcpPort: 3603 status: 'disabled' } startStub = sinon.stub tcpAdapter, 'notifyMasterToStartTCPServer' stopStub = sinon.stub tcpAdapter, 'notifyMasterToStopTCPServer' httpChannel.save -> request("https://localhost:8080") .put("/channels/" + httpChannel._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(changeToTCPDisabled) .expect(200) .end (err, res) -> if err done err else startStub.should.not.be.called stopStub.should.be.calledOnce startStub.restore() stopStub.restore() done() it 'should register the updated channel with the polling service if of type "polling"', (done) -> pollChannel = new Channel name: "POLLINGTestChannel-Update" urlPattern: "/trigger" allow: [ 'polling' ] type: 'polling' pollingSchedule: '5 * * * *' routes: [ name: "PollRoute" host: "localhost" port: 9876 primary: true ] spy = sinon.spy polling, 'registerPollingChannel' pollChannel.save -> request("https://localhost:8080") .put("/channels/" + pollChannel._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(pollChannel) .expect(200) .end (err, res) -> spy.restore() if err done err else spy.calledOnce.should.be.true spy.getCall(0).args[0].should.have.property 'name', 'POLLINGTestChannel-Update' spy.getCall(0).args[0].should.have.property 'urlPattern', '/trigger' spy.getCall(0).args[0].should.have.property 'type', 'polling' spy.getCall(0).args[0].should.have.property '_id', pollChannel._id done() it 'should NOT register the updated channel with the polling service if of type "polling" but it is disabled', (done) -> pollChannel = new Channel name: "POLLINGTestChannel-Update-Disabled" urlPattern: "/trigger" allow: [ 'polling' ] type: 'polling' pollingSchedule: '5 * * * *' routes: [ name: "PollRoute" host: "localhost" port: 9876 primary: true ] status: 'disabled' spy = sinon.spy polling, 'registerPollingChannel' pollChannel.save -> request("https://localhost:8080") .put("/channels/" + pollChannel._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(pollChannel) .expect(200) .end (err, res) -> spy.restore() if err done err else spy.callCount.should.be.exactly 0 done() it 'should reject an update with no primary routes', (done) -> updates = urlPattern: "test/changed" allow: [ "PoC", "Test1", "Test2", "another" ] routes: [ name: "test route" host: "localhost" port: 9876 , name: "test route2" host: "localhost" port: 8899 ] request("https://localhost:8080") .put("/channels/" + channel1._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(updates) .expect(400) .end (err, res) -> if err done err else done() it 'should reject an update with multiple primary routes', (done) -> updates = urlPattern: "test/changed" allow: [ "PoC", "Test1", "Test2", "another" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true , name: "test route2" host: "localhost" port: 8899 primary: true ] request("https://localhost:8080") .put("/channels/" + channel1._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(updates) .expect(400) .end (err, res) -> if err done err else done() it 'should accept an update with one primary route and multiple disabled primary routes', (done) -> updates = urlPattern: "test/changed" allow: [ "PoC", "Test1", "Test2", "another" ] routes: [ name: "test route" host: "localhost" port: 9876 primary: true , name: "test route2" host: "localhost" port: 8899 primary: true status: 'disabled' ] request("https://localhost:8080") .put("/channels/" + channel1._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(updates) .expect(200) .end (err, res) -> if err done err else done() it 'should NOT update a channel with a priority below 1', (done) -> updates = urlPattern: "test/changed" priority: -1 request("https://localhost:8080") .put("/channels/" + channel1._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .send(updates) .expect(400) .end (err, res) -> if err done err else Channel.findOne { name: "TestChannel1" }, (err, channel) -> channel.should.have.property "urlPattern", "test/sample" done() describe '*removeChannel(channelId)', -> it 'should remove a specific channel by name', (done) -> Transaction.find { channelID: channel1._id }, (err, trx) -> # there can't be any linked transactions trx.length.should.be.exactly 0 request("https://localhost:8080") .del("/channels/" + channel1._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(200) .end (err, res) -> if err done err else Channel.find { name: "TestChannel1" }, (err, channels) -> channels.should.have.length 0 done() it 'should only allow an admin user to remove a channel', (done) -> request("https://localhost:8080") .del("/channels/" + channel1._id) .set("auth-username", testUtils.nonRootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(403) .end (err, res) -> if err done err else done() it 'should remove polling schedule if the channel is of type "polling"', (done) -> pollChannel = new Channel name: "POLLINGTestChannel-Remove" urlPattern: "/trigger" allow: [ 'polling' ] type: 'polling' pollingSchedule: '5 * * * *' routes: [ name: "PollRoute" host: "localhost" port: 9876 primary: true ] spy = sinon.spy polling, 'removePollingChannel' Transaction.find { channelID: channel1._id }, (err, trx) -> # there can't be any linked transactions trx.length.should.be.exactly 0 pollChannel.save -> request("https://localhost:8080") .del("/channels/" + pollChannel._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(200) .end (err, res) -> spy.restore() if err done err else spy.calledOnce.should.be.true spy.getCall(0).args[0].should.have.property 'name', 'POLLINGTestChannel-Remove' spy.getCall(0).args[0].should.have.property '_id', pollChannel._id done() it 'should NOT remove a specific channel if any transactions are linked to it but mark the status as deleted', (done) -> trx = new Transaction clientID: channel1._id #not really but anyway channelID: channel1._id request: path: '/test/remove' method: 'GET' timestamp: new Date() status: 'Successful' trx.save (err) -> return done err if err request("https://localhost:8080") .del("/channels/" + channel1._id) .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(200) .end (err, res) -> if err done err else Channel.find { name: "TestChannel1" }, (err, channels) -> channels.should.have.length 1 channels[0].status.should.exist channels[0].status.should.be.equal 'deleted' done() describe '*manuallyPollChannel', -> it 'should manually poll a channel', (done) -> request("https://localhost:8080") .post("/channels/" + channel1._id + "/trigger") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(200) .end (err, res) -> if err done err else done() it 'should reject a manually polled channel - channel not found', (done) -> mongoose = require('mongoose'); invalidId = mongoose.Types.ObjectId('4eeeeeeeeeeeeeeeebbbbbb2'); request("https://localhost:8080") .post("/channels/" + invalidId + "/trigger") .set("auth-username", testUtils.rootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(404) .end (err, res) -> if err done err else done() it 'should not allow a non admin user from manually polling a channel they do not have access to', (done) -> request("https://localhost:8080") .post("/channels/" + channel1._id + "/trigger") .set("auth-username", testUtils.nonRootUser.email) .set("auth-ts", authDetails.authTS) .set("auth-salt", authDetails.authSalt) .set("auth-token", authDetails.authToken) .expect(403) .end (err, res) -> if err done err else done()