Package com.vaadin.flow.component.upload

Class UploadDropZoneTester<T extends UploadDropZone>

java.lang.Object

com.vaadin.browserless.ComponentTester<T>

com.vaadin.flow.component.upload.UploadDropZoneTester<T>

Type Parameters:

T - the component type.

All Implemented Interfaces:

Clickable<T>

public class UploadDropZoneTester<T extends UploadDropZone>
extends ComponentTester<T>

Tester for UploadDropZone components.

Dropping files on the drop zone hands them to the UploadManager the drop zone is linked to, which checks them against its maxFiles, maxFileSize and accepted file types the same way the browser does: a file failing one of them fires a UploadManager.FileRejectedEvent and never reaches the upload handler. A refused file is no more of an error here than in the browser, so dropping does not throw for it. Use getLastUploadStatus() to see what became of each file, or ensureUploaded() to fail the test unless every file went through.

The manager keeps the files in a file list shared by every component linked to it, and maxFiles is checked against that list. As in the browser, the drop zone is not usable while it is not linked to a manager, while the manager is disabled, or once the file list holds maxFiles files.

When auto upload is turned off, accepted files wait in the file list until they are started with UploadFileListTester.startUpload(String).

Constructor Summary

Constructors

Constructor	Description
UploadDropZoneTester(T component)	Wrap given component for testing.

Method Summary

Modifier and Type	Method	Description
void	drop(File... files)	Simulates the user dropping the given files on the drop zone.
void	drop(String fileName, String contentType, byte[] contents)	Simulates the user dropping a file with the given name, content type and contents on the drop zone.
void	drop(Collection<File> files)	Simulates the user dropping the given files on the drop zone.
void	ensureUploaded()	Checks that the last upload through the UploadManager the drop zone is linked to delivered every one of its files, and fails otherwise.
void	ensureUploadFailed()	Checks that at least one file of the last upload through the UploadManager the drop zone is linked to failed or was rejected, and fails otherwise.
List<UploadTester.FileStatus>	getLastUploadStatus()	Returns what happened to each file the user last selected, dropped or started through the UploadManager the drop zone is linked to, in the order the files were given.
boolean	isUsable()	Validate that component can be interacted with and should be visible in the UI.
protected void	notUsableReasons(Consumer<String> collector)	Provides messages explaining why the component is actually not usable.
void	uploadAborted(File file)	Simulates the user dropping the given file on the drop zone and then aborting its upload.
void	uploadAborted(String fileName, String contentType)	Simulates the user dropping a file with the given name and content type on the drop zone and then aborting its upload.
void	uploadFailed(File file)	Simulates the user dropping the given file on the drop zone and its upload then failing.
void	uploadFailed(String fileName, String contentType)	Simulates the user dropping a file with the given name and content type on the drop zone and its upload then failing.

Methods inherited from class com.vaadin.browserless.ComponentTester

blur, canSetValueAsUser, clearAsUser, clickClearButtonAsUser, ensureComponentIsUsable, ensureComponentIsUsable, ensureComponentIsUsableOrDetach, ensureVisible, ensureVisible, find, findAllByQuery, findByQuery, fireDomEvent, fireDomEvent, fireDomEvent, focus, getComponent, getField, getField, getMethod, getMethod, isComponentReadOnly, isFocused, isUsable, notUsableReasons, roundTrip, setModal, setPropertyAsUser, setValueAsUser, setValueAsUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.browserless.Clickable

click, click, click, middleClick, middleClick, rightClick, rightClick

Constructor Details

UploadDropZoneTester

public UploadDropZoneTester(T component)

Wrap given component for testing.

Parameters:

component - target component

Method Details

drop

public void drop(File... files)

Simulates the user dropping the given files on the drop zone.

The content types are detected from the file names.

Parameters:

files - the files to drop

Throws:

UncheckedIOException - if the upload handler fails to handle the file contents

IllegalArgumentException - if no file is given

IllegalStateException - if the component is not usable

drop

public void drop(Collection<File> files)

Simulates the user dropping the given files on the drop zone.

The content types are detected from the file names.

Parameters:

files - the files to drop

Throws:

UncheckedIOException - if the upload handler fails to handle the file contents

IllegalArgumentException - if no file is given

IllegalStateException - if the component is not usable

drop

public void drop(String fileName,
 String contentType,
 byte[] contents)

Simulates the user dropping a file with the given name, content type and contents on the drop zone.

Parameters:

fileName - name of the file to drop

contentType - content type of the file to drop

contents - file contents as an array of bytes

Throws:

UncheckedIOException - if the upload handler fails to handle the file contents

IllegalStateException - if the component is not usable

uploadAborted

public void uploadAborted(File file)

Simulates the user dropping the given file on the drop zone and then aborting its upload.

As in the browser, the aborted file is dropped from the file list and a UploadManager.FileRemovedEvent is fired, freeing a slot when UploadManager.setMaxFiles(int) is in use.

The file is added and its transfer started in one go, whether or not auto upload is turned off. The content type is detected from the file name, and the file is not read.

Parameters:

file - the file to drop

Throws:

IllegalStateException - if the component is not usable

uploadAborted

public void uploadAborted(String fileName,
 String contentType)

Simulates the user dropping a file with the given name and content type on the drop zone and then aborting its upload.

As in the browser, the aborted file is dropped from the file list and a UploadManager.FileRemovedEvent is fired, freeing a slot when UploadManager.setMaxFiles(int) is in use.

The file is added and its transfer started in one go, whether or not auto upload is turned off.

Parameters:

fileName - name of the file to drop

contentType - content type of the file to drop

Throws:

IllegalStateException - if the component is not usable

uploadFailed

public void uploadFailed(File file)

Simulates the user dropping the given file on the drop zone and its upload then failing.

As in the browser, a file whose upload failed stays in the file list.

The file is added and its transfer started in one go, whether or not auto upload is turned off. The content type is detected from the file name, and the file is not read.

Parameters:

file - the file to drop

Throws:

IllegalStateException - if the component is not usable

uploadFailed

public void uploadFailed(String fileName,
 String contentType)

Simulates the user dropping a file with the given name and content type on the drop zone and its upload then failing.

As in the browser, a file whose upload failed stays in the file list.

The file is added and its transfer started in one go, whether or not auto upload is turned off.

Parameters:

fileName - name of the file to drop

contentType - content type of the file to drop

Throws:

IllegalStateException - if the component is not usable

getLastUploadStatus

public List<UploadTester.FileStatus> getLastUploadStatus()

Returns what happened to each file the user last selected, dropped or started through the UploadManager the drop zone is linked to, in the order the files were given.

Files are reported as UploadTester.UploadStatus.UPLOADED once the upload handler has consumed them, as UploadTester.UploadStatus.REJECTED when the manager or Flow's server-side accepted type validation refused them, as UploadTester.UploadStatus.FAILED when the handler threw, and as UploadTester.UploadStatus.PENDING while they wait in the file list for auto upload being turned off. The error message of a file the manager refused is the client-side error code: tooManyFiles, fileIsTooBig or incorrectFileType.

Returns:

the outcome of the last upload, one entry per file, or an empty list if nothing has been uploaded yet or the drop zone is not linked to a manager

ensureUploaded

public void ensureUploaded()

Checks that the last upload through the UploadManager the drop zone is linked to delivered every one of its files, and fails otherwise.

Throws:

IllegalStateException - if no upload has been simulated, or if any file of the last upload was not uploaded

See Also:

• getLastUploadStatus()

ensureUploadFailed

public void ensureUploadFailed()

Checks that at least one file of the last upload through the UploadManager the drop zone is linked to failed or was rejected, and fails otherwise.

Counterpart of ensureUploaded() for a test about the failure case, such as an upload handler that throws or a file the manager refuses. Use getLastUploadStatus() to check which file failed and why.

A file left UploadTester.UploadStatus.PENDING does not count as failed: it was neither delivered nor refused, such as a file waiting because auto upload is turned off.

Throws:

IllegalStateException - if no upload has been simulated, or if no file of the last upload failed or was rejected

See Also:

• getLastUploadStatus()

isUsable

public boolean isUsable()

Description copied from class: ComponentTester

Validate that component can be interacted with and should be visible in the UI. Subclasses overriding this method should also override ComponentTester.notUsableReasons(Consumer) to provide additional details to the potential exception thrown by ComponentTester.ensureComponentIsUsable().

Overrides:

isUsable in class ComponentTester<T extends UploadDropZone>

Returns:

true if component can be interacted with by the user

See Also:

• ComponentTester.notUsableReasons(Consumer)
• ComponentTester.ensureComponentIsUsable()

notUsableReasons

protected void notUsableReasons(Consumer<String> collector)

Description copied from class: ComponentTester

Provides messages explaining why the component is actually not usable. Subclasses overriding ComponentTester.isUsable() should also override this method to provide additional details to the potential exception throw by ComponentTester.ensureComponentIsUsable().

Overrides:

notUsableReasons in class ComponentTester<T extends UploadDropZone>

See Also:

• ComponentTester.isUsable()
• ComponentTester.ensureComponentIsUsable()