forked from NCEAS/metacatui
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test: Adds unit tests for DataItemView,DataPackage
- new test spec for DataItemView. Specifically tests uploadFilesInBatch and addFiles in relation to NCEAS#2224 - Adds to test spec for DataPackage. Specifically tests fetchMemberModels functionality in relation to NCEAS#2547 - Ensures comments provide context and purpose for each action in the tests
- Loading branch information
Showing
5 changed files
with
235 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| define([ | ||
| "jquery", | ||
| "underscore", | ||
| "backbone", | ||
| "models/DataONEObject", | ||
| "views/DataItemView", | ||
| ], function ($, _, Backbone, DataONEObject, DataItemView) { | ||
| var expect = chai.expect; | ||
|
|
||
| describe("DataItemView Test Suite", function () { | ||
| let dataItemView, model, collection; | ||
|
|
||
| // Set up the test environment before each test | ||
| beforeEach(function () { | ||
| // Create a new DataONEObject model with a test identifier | ||
| model = new DataONEObject({ identifier: "test-id" }); | ||
| // Create a new Backbone collection | ||
| collection = new Backbone.Collection(); | ||
| // Initialize the DataItemView with the model and collection | ||
| dataItemView = new DataItemView({ | ||
| model: model, | ||
| collection: collection | ||
| }); | ||
|
|
||
| // Stub the getParentScienceMetadata function to return a mock object | ||
| sinon.stub(dataItemView, "getParentScienceMetadata").returns({ | ||
| id: "mock-sci-meta-id" | ||
| }); | ||
|
|
||
| // Stub the getParentDataPackage function to return a mock object with a spy on the add method | ||
| sinon.stub(dataItemView, "getParentDataPackage").returns({ | ||
| packageModel: { id: "mock-package-id" }, | ||
| add: sinon.spy() | ||
| }); | ||
| }); | ||
|
|
||
| // Clean up the test environment after each test | ||
| afterEach(function () { | ||
| // Restore the stubbed methods to their original implementations | ||
| dataItemView.getParentScienceMetadata.restore(); | ||
| dataItemView.getParentDataPackage.restore(); | ||
| dataItemView.remove(); | ||
| }); | ||
|
|
||
| describe("uploadFilesInBatch", function () { | ||
| it("should upload files in batches", function (done) { | ||
| // Create a list of DataONEObject models with initial upload status | ||
| const fileList = [ | ||
| new DataONEObject({ uploadFile: true, uploadStatus: "l" }), | ||
| new DataONEObject({ uploadFile: true, uploadStatus: "l" }), | ||
| new DataONEObject({ uploadFile: true, uploadStatus: "l" }) | ||
| ]; | ||
|
|
||
| // Define the batch size for the upload | ||
| const batchSize = 2; | ||
| // Spy on the uploadFilesInBatch method to verify its call | ||
| const uploadSpy = sinon.spy(dataItemView, "uploadFilesInBatch"); | ||
| // Stub the save method to simulate setting the upload status to "p" | ||
| const saveStub = sinon.stub(DataONEObject.prototype, "save").callsFake(function () { | ||
| this.set("uploadStatus", "p"); | ||
| }); | ||
| // Stub the calculateChecksum method to simulate setting checksum attributes | ||
| const checksumStub = sinon.stub(DataONEObject.prototype, "calculateChecksum").callsFake(function () { | ||
| this.set("checksum", "fakeChecksum"); | ||
| this.set("checksumAlgorithm", "fakeAlgorithm"); | ||
| this.trigger("checksumCalculated", this.attributes); | ||
| }); | ||
|
|
||
| // Call the method to be tested | ||
| dataItemView.uploadFilesInBatch(fileList, batchSize); | ||
|
|
||
| // Simulate the completion of the upload by setting the upload status to "c" | ||
| fileList.forEach(function (file) { | ||
| file.set("uploadStatus", "c"); | ||
| }); | ||
|
|
||
| // Use setTimeout to allow asynchronous operations to complete | ||
| setTimeout(function () { | ||
| // Log the call counts for debugging purposes | ||
| console.log("[should upload files in batches] uploadSpy.callCount: ", uploadSpy.callCount); | ||
| console.log("[should upload files in batches] checksumSpy.callCount: ", checksumStub.callCount); | ||
|
|
||
| // Verify that the method was called once with the correct arguments | ||
| expect(uploadSpy.calledOnce).to.be.true; | ||
| expect(uploadSpy.calledWith(fileList, batchSize)).to.be.true; | ||
| // Verify that the calculateChecksum method was called the expected number of times | ||
| console.log("[should upload files in batches] fileList.length: ", fileList.length); | ||
| console.log("[should upload files in batches] saveSpy.callCount: ", saveStub.callCount); | ||
| expect(checksumStub.callCount).to.equal(fileList.length); | ||
| expect(saveStub.callCount).to.equal(fileList.length); | ||
| // Restore the spies and stubs | ||
| uploadSpy.restore(); | ||
| checksumStub.restore(); | ||
| saveStub.restore(); | ||
| // Indicate that the test is complete | ||
| done(); | ||
| }, 0); | ||
| }); | ||
| }); | ||
|
|
||
| describe("addFiles", function () { | ||
| it("should add files to the collection", function (done) { | ||
| // Create a fake file object to simulate a file upload | ||
| const fakeFile = new Blob(["fake file content"], { type: "text/plain" }); | ||
| fakeFile.name = "fakeFile.txt"; | ||
|
|
||
| // Create a mock event object with the necessary properties | ||
| const event = { | ||
| stopPropagation: sinon.spy(), | ||
| preventDefault: sinon.spy(), | ||
| target: { files: [fakeFile] }, | ||
| originalEvent: { dataTransfer: { files: [fakeFile] } }, | ||
| delegateTarget: { dataset: { id: "test-id" } } | ||
| }; | ||
|
|
||
| // Stub the methods to simulate their behavior | ||
| const uploadStub = sinon.stub(dataItemView, "uploadFilesInBatch").returns(true); | ||
| const d1ObjectStub = sinon.stub(DataONEObject.prototype, "initialize").returns(true); | ||
|
|
||
| // Call the method to be tested | ||
| dataItemView.addFiles.call(dataItemView, event); | ||
|
|
||
| // Use setTimeout to allow asynchronous operations to complete | ||
| setTimeout(function () { | ||
| // Verify that the event methods were called | ||
| expect(event.stopPropagation.calledOnce).to.be.true; | ||
| expect(event.preventDefault.calledOnce).to.be.true; | ||
| // Verify that the DataONEObject initialize method was called | ||
| console.log("[should add files to the collection] d1ObjectStub.callCount: ", d1ObjectStub.callCount); | ||
| expect(d1ObjectStub.calledOnce).to.be.true; | ||
| // Verify that the uploadFilesInBatch method was called | ||
| console.log("[should add files to the collection] uploadStub.callCount: ", uploadStub.callCount); | ||
| expect(uploadStub.calledOnce).to.be.true; | ||
| // Restore the stubs | ||
| uploadStub.restore(); | ||
| d1ObjectStub.restore(); | ||
| // Indicate that the test is complete | ||
| done(); | ||
| }, 0); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |