From c27df0bfef078543dbebe8e8f2e92c4f73ae44ac Mon Sep 17 00:00:00 2001 From: Hayden Faulds Date: Thu, 5 Oct 2017 10:20:58 +0100 Subject: [PATCH] split apart multi and rclient in tests --- .../RedisManager/RedisManagerTests.coffee | 121 +++++++++--------- 1 file changed, 60 insertions(+), 61 deletions(-) diff --git a/services/document-updater/test/unit/coffee/RedisManager/RedisManagerTests.coffee b/services/document-updater/test/unit/coffee/RedisManager/RedisManagerTests.coffee index 62115f4bd3..b76eba319e 100644 --- a/services/document-updater/test/unit/coffee/RedisManager/RedisManagerTests.coffee +++ b/services/document-updater/test/unit/coffee/RedisManager/RedisManagerTests.coffee @@ -9,10 +9,8 @@ tk = require "timekeeper" describe "RedisManager", -> beforeEach -> - @rclient = - auth: () -> - exec: sinon.stub() - @rclient.multi = () => @rclient + @multi = exec: sinon.stub() + @rclient = multi: () => @multi tk.freeze(new Date()) @RedisManager = SandboxedModule.require modulePath, requires: @@ -70,8 +68,8 @@ describe "RedisManager", -> @json_ranges = JSON.stringify @ranges @unflushed_time = 12345 @pathname = '/a/b/c.tex' - @rclient.get = sinon.stub() - @rclient.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @hash, @project_id, @json_ranges, @pathname, @unflushed_time]) + @multi.get = sinon.stub() + @multi.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @hash, @project_id, @json_ranges, @pathname, @unflushed_time]) @rclient.sadd = sinon.stub().yields(null, 0) describe "successfully", -> @@ -79,32 +77,32 @@ describe "RedisManager", -> @RedisManager.getDoc @project_id, @doc_id, @callback it "should get the lines from redis", -> - @rclient.get + @multi.get .calledWith("doclines:#{@doc_id}") .should.equal true it "should get the version from", -> - @rclient.get + @multi.get .calledWith("DocVersion:#{@doc_id}") .should.equal true it 'should get the hash', -> - @rclient.get + @multi.get .calledWith("DocHash:#{@doc_id}") .should.equal true it "should get the ranges", -> - @rclient.get + @multi.get .calledWith("Ranges:#{@doc_id}") .should.equal true it "should get the unflushed time", -> - @rclient.get + @multi.get .calledWith("UnflushedTime:#{@doc_id}") .should.equal true it "should get the pathname", -> - @rclient.get + @multi.get .calledWith("Pathname:#{@doc_id}") .should.equal true @@ -124,7 +122,7 @@ describe "RedisManager", -> describe "when the document is not present", -> beforeEach -> - @rclient.exec = sinon.stub().callsArgWith(0, null, [null, null, null, null, null, null, null]) + @multi.exec = sinon.stub().callsArgWith(0, null, [null, null, null, null, null, null, null]) @rclient.sadd = sinon.stub().yields() @RedisManager.getDoc @project_id, @doc_id, @callback @@ -159,7 +157,7 @@ describe "RedisManager", -> describe "with a corrupted document", -> beforeEach -> @badHash = "INVALID-HASH-VALUE" - @rclient.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @badHash, @project_id, @json_ranges]) + @multi.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @badHash, @project_id, @json_ranges]) @RedisManager.getDoc @project_id, @doc_id, @callback it 'should log a hash error', -> @@ -174,9 +172,9 @@ describe "RedisManager", -> describe "with a slow request to redis", -> beforeEach -> - @rclient.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @badHash, @project_id, @json_ranges, @pathname, @unflushed_time]) + @multi.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @badHash, @project_id, @json_ranges, @pathname, @unflushed_time]) @clock = sinon.useFakeTimers(); - @rclient.exec = (cb) => + @multi.exec = (cb) => @clock.tick(6000); cb(null, [@jsonlines, @version, @another_project_id, @json_ranges, @pathname, @unflushed_time]) @@ -193,7 +191,7 @@ describe "RedisManager", -> describe "getDoc with an invalid project id", -> beforeEach -> @another_project_id = "project-id-456" - @rclient.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @hash, @another_project_id, @json_ranges, @pathname, @unflushed_time]) + @multi.exec = sinon.stub().callsArgWith(0, null, [@jsonlines, @version, @hash, @another_project_id, @json_ranges, @pathname, @unflushed_time]) @RedisManager.getDoc @project_id, @doc_id, @callback it 'should return an error', -> @@ -316,12 +314,12 @@ describe "RedisManager", -> describe "updateDocument", -> beforeEach -> - @rclient.set = sinon.stub() - @rclient.rpush = sinon.stub() - @rclient.expire = sinon.stub() - @rclient.ltrim = sinon.stub() - @rclient.del = sinon.stub() - @rclient.eval = sinon.stub() + @multi.set = sinon.stub() + @multi.rpush = sinon.stub() + @multi.expire = sinon.stub() + @multi.ltrim = sinon.stub() + @multi.del = sinon.stub() + @multi.eval = sinon.stub() @RedisManager.getDocVersion = sinon.stub() @lines = ["one", "two", "three", "これは"] @@ -330,7 +328,7 @@ describe "RedisManager", -> @hash = crypto.createHash('sha1').update(JSON.stringify(@lines),'utf8').digest('hex') @ranges = { comments: "mock", entries: "mock" } - @rclient.exec = sinon.stub().callsArg(0, null, [@hash]) + @multi.exec = sinon.stub().callsArg(0, null, [@hash]) describe "with a consistent version", -> beforeEach -> @@ -343,42 +341,42 @@ describe "RedisManager", -> .should.equal true it "should set the doclines", -> - @rclient.eval + @multi.eval .calledWith(sinon.match(/redis.call/), 1, "doclines:#{@doc_id}", JSON.stringify(@lines)) .should.equal true it "should set the version", -> - @rclient.set + @multi.set .calledWith("DocVersion:#{@doc_id}", @version) .should.equal true it "should set the hash", -> - @rclient.set + @multi.set .calledWith("DocHash:#{@doc_id}", @hash) .should.equal true it "should set the ranges", -> - @rclient.set + @multi.set .calledWith("Ranges:#{@doc_id}", JSON.stringify(@ranges)) .should.equal true it "should set the unflushed time", -> - @rclient.set + @multi.set .calledWith("UnflushedTime:#{@doc_id}", Date.now(), "NX") .should.equal true it "should push the doc op into the doc ops list", -> - @rclient.rpush + @multi.rpush .calledWith("DocOps:#{@doc_id}", JSON.stringify(@ops[0]), JSON.stringify(@ops[1])) .should.equal true it "should renew the expiry ttl on the doc ops array", -> - @rclient.expire + @multi.expire .calledWith("DocOps:#{@doc_id}", @RedisManager.DOC_OPS_TTL) .should.equal true it "should truncate the list to 100 members", -> - @rclient.ltrim + @multi.ltrim .calledWith("DocOps:#{@doc_id}", -@RedisManager.DOC_OPS_MAX_LENGTH, -1) .should.equal true @@ -395,7 +393,7 @@ describe "RedisManager", -> @RedisManager.updateDocument @doc_id, @lines, @version, @ops, @ranges, @callback it "should not call multi.exec", -> - @rclient.exec.called.should.equal false + @multi.exec.called.should.equal false it "should call the callback with an error", -> @callback @@ -404,16 +402,17 @@ describe "RedisManager", -> describe "with no updates", -> beforeEach -> + @multi.rpush = sinon.stub().callsArg(1) @RedisManager.getDocVersion.withArgs(@doc_id).yields(null, @version) @RedisManager.updateDocument @doc_id, @lines, @version, [], @ranges, @callback it "should not do an rpush", -> - @rclient.rpush + @multi.rpush .called .should.equal false it "should still set the doclines", -> - @rclient.eval + @multi.eval .calledWith(sinon.match(/redis.call/), 1, "doclines:#{@doc_id}", JSON.stringify(@lines)) .should.equal true @@ -423,19 +422,19 @@ describe "RedisManager", -> @RedisManager.updateDocument @doc_id, @lines, @version, @ops, {}, @callback it "should not set the ranges", -> - @rclient.set + @multi.set .calledWith("Ranges:#{@doc_id}", JSON.stringify(@ranges)) .should.equal false it "should delete the ranges key", -> - @rclient.del + @multi.del .calledWith("Ranges:#{@doc_id}") .should.equal true describe "with a corrupted write", -> beforeEach -> @badHash = "INVALID-HASH-VALUE" - @rclient.exec = sinon.stub().callsArgWith(0, null, [@badHash]) + @multi.exec = sinon.stub().callsArgWith(0, null, [@badHash]) @RedisManager.getDocVersion.withArgs(@doc_id).yields(null, @version - @ops.length) @RedisManager.updateDocument @doc_id, @lines, @version, @ops, @ranges, @callback @@ -476,14 +475,14 @@ describe "RedisManager", -> describe "putDocInMemory", -> beforeEach -> - @rclient.set = sinon.stub() + @multi.set = sinon.stub() @rclient.sadd = sinon.stub().yields() - @rclient.del = sinon.stub() - @rclient.eval = sinon.stub() + @multi.del = sinon.stub() + @multi.eval = sinon.stub() @lines = ["one", "two", "three", "これは"] @version = 42 @hash = crypto.createHash('sha1').update(JSON.stringify(@lines),'utf8').digest('hex') - @rclient.exec = sinon.stub().callsArgWith(0, null, [@hash]) + @multi.exec = sinon.stub().callsArgWith(0, null, [@hash]) @ranges = { comments: "mock", entries: "mock" } @pathname = '/a/b/c.tex' @@ -492,32 +491,32 @@ describe "RedisManager", -> @RedisManager.putDocInMemory @project_id, @doc_id, @lines, @version, @ranges, @pathname, done it "should set the lines", -> - @rclient.eval + @multi.eval .calledWith(sinon.match(/redis.call/), 1, "doclines:#{@doc_id}", JSON.stringify(@lines)) .should.equal true it "should set the version", -> - @rclient.set + @multi.set .calledWith("DocVersion:#{@doc_id}", @version) .should.equal true it "should set the hash", -> - @rclient.set + @multi.set .calledWith("DocHash:#{@doc_id}", @hash) .should.equal true it "should set the ranges", -> - @rclient.set + @multi.set .calledWith("Ranges:#{@doc_id}", JSON.stringify(@ranges)) .should.equal true it "should set the project_id for the doc", -> - @rclient.set + @multi.set .calledWith("ProjectId:#{@doc_id}", @project_id) .should.equal true it "should set the pathname for the doc", -> - @rclient.set + @multi.set .calledWith("Pathname:#{@doc_id}", @pathname) .should.equal true @@ -535,18 +534,18 @@ describe "RedisManager", -> @RedisManager.putDocInMemory @project_id, @doc_id, @lines, @version, {}, @pathname, done it "should delete the ranges key", -> - @rclient.del + @multi.del .calledWith("Ranges:#{@doc_id}") .should.equal true it "should not set the ranges", -> - @rclient.set + @multi.set .calledWith("Ranges:#{@doc_id}", JSON.stringify(@ranges)) .should.equal false describe "with a corrupted write", -> beforeEach (done) -> - @rclient.exec = sinon.stub().callsArgWith(0, null, ["INVALID-HASH-VALUE"]) + @multi.exec = sinon.stub().callsArgWith(0, null, ["INVALID-HASH-VALUE"]) @RedisManager.putDocInMemory @project_id, @doc_id, @lines, @version, @ranges, @pathname, done it 'should log a hash error', -> @@ -581,43 +580,43 @@ describe "RedisManager", -> describe "removeDocFromMemory", -> beforeEach (done) -> - @rclient.del = sinon.stub() - @rclient.srem = sinon.stub() - @rclient.exec.yields() + @multi.del = sinon.stub() + @multi.srem = sinon.stub() + @multi.exec.yields() @RedisManager.removeDocFromMemory @project_id, @doc_id, done it "should delete the lines", -> - @rclient.del + @multi.del .calledWith("doclines:#{@doc_id}") .should.equal true it "should delete the version", -> - @rclient.del + @multi.del .calledWith("DocVersion:#{@doc_id}") .should.equal true it "should delete the hash", -> - @rclient.del + @multi.del .calledWith("DocHash:#{@doc_id}") .should.equal true it "should delete the unflushed time", -> - @rclient.del + @multi.del .calledWith("UnflushedTime:#{@doc_id}") .should.equal true it "should delete the project_id for the doc", -> - @rclient.del + @multi.del .calledWith("ProjectId:#{@doc_id}") .should.equal true it "should remove the doc_id from the project set", -> - @rclient.srem + @multi.srem .calledWith("DocsIn:#{@project_id}", @doc_id) .should.equal true it "should delete the pathname for the doc", -> - @rclient.del + @multi.del .calledWith("Pathname:#{@doc_id}") .should.equal true