Sfoglia il codice sorgente

Small test fixes, test utils documentation.

Szymon Kupś 8 anni fa
parent
commit
1e010ca1e5

+ 54 - 5
packages/ckeditor5-upload/tests/_utils/mocks.js

@@ -3,16 +3,28 @@
  * For licensing, see LICENSE.md.
  */
 
+/**
+ * Returns object that mocks native File object.
+ */
 export const createNativeFileMock = () => ( {
 	type: 'image/jpeg',
 	size: 1024
 } );
 
+/**
+ * AdapterMock class.
+ * Simulates adapter behaviour without any server-side communications.
+ */
 export class AdapterMock {
 	constructor( loader ) {
 		this.loader = loader;
 	}
 
+	/**
+	 * Starts mocked upload process.
+	 *
+	 * @returns {Promise}
+	 */
 	upload() {
 		return new Promise( ( resolve, reject ) => {
 			this._resolveCallback = resolve;
@@ -24,45 +36,82 @@ export class AdapterMock {
 		} );
 	}
 
+	/**
+	 * Aborts reading.
+	 */
 	abort() {
 		this._rejectCallback( 'aborted' );
 	}
 
+	/**
+	 * Allows to mock error during file upload.
+	 *
+	 * @param { Object } error
+	 */
 	mockError( error ) {
 		this._rejectCallback( error );
 	}
 
+	/**
+	 * Allows to mock file upload success.
+	 *
+	 * @param { Object } data Mock data returned from server passed to resolved promise.
+	 */
 	mockSuccess( data ) {
 		this._resolveCallback( data );
 	}
 
+	/**
+	 * Allows to mock file upload progress.
+	 *
+	 * @param {Number} uploaded Bytes uploaded.
+	 * @param {Number} total Total bytes to upload.
+	 */
 	mockProgress( uploaded, total ) {
 		this.loader.uploaded = uploaded;
 		this.loader.uploadTotal = total;
 	}
 }
 
+/**
+ * NativeFileReaderMock class.
+ * Simulates FileReader behaviour.
+ */
 export class NativeFileReaderMock {
+	/**
+	 * Mock method used to initialize reading.
+	 */
 	readAsDataURL() {}
 
+	/**
+	 * Aborts reading process.
+	 */
 	abort() {
-		this.mockAbort();
+		this.onabort();
 	}
 
+	/**
+	 * Allows to mock file reading success.
+	 * @param {*} result File reading result.
+	 */
 	mockSuccess( result ) {
 		this.result = result;
 		this.onload();
 	}
 
+	/**
+	 * Allows to mock error during file read.
+	 *
+	 * @param { Object } error
+	 */
 	mockError( error ) {
 		this.error = error;
 		this.onerror();
 	}
 
-	mockAbort() {
-		this.onabort();
-	}
-
+	/**
+	 * Allows to mock file upload progress.
+	 */
 	mockProgress( progress ) {
 		this.onprogress( { loaded: progress } );
 	}

+ 1 - 1
packages/ckeditor5-upload/tests/filereader.js

@@ -75,7 +75,7 @@ describe( 'FileReader', () => {
 					expect( status ).to.equal( 'aborted' );
 				} );
 
-			nativeReaderMock.mockAbort();
+			nativeReaderMock.abort();
 
 			return promise;
 		} );

+ 1 - 1
packages/ckeditor5-upload/tests/imageuploadengine.js

@@ -182,7 +182,7 @@ describe( 'ImageUploadEngine', () => {
 
 		setModelData( document, '<paragraph>{}foo bar</paragraph>' );
 		editor.execute( 'imageUpload', { file } );
-		nativeReaderMock.mockAbort();
+		nativeReaderMock.abort();
 
 		setTimeout( () => {
 			sinon.assert.notCalled( spy );