com.github.mvysny.kaributesting.v10.groovy.UploadUtils.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of karibu-testing-v10-groovy Show documentation

Karibu Testing, support for browserless Vaadin testing in Kotlin

There is a newer version: 2.2.0

Show newest version

package com.github.mvysny.kaributesting.v10.groovy

import com.github.mvysny.kaributesting.v10.UploadKt
import com.vaadin.flow.component.upload.Upload
import groovy.transform.CompileStatic
import org.jetbrains.annotations.NotNull
import org.jetbrains.annotations.Nullable

/**
 * {@link Upload}-related utilities.
 * @author mavi
 */
@CompileStatic
class UploadUtils {
    /**
     * Invokes {@link com.vaadin.flow.component.upload.StartedEvent}, then feeds given
     * file to the {@link Upload#getReceiver()}, then
     * invokes the {@link com.vaadin.flow.component.upload.SucceededEvent} and
     * {@link com.vaadin.flow.component.upload.FinishedEvent} listeners.
     * Doesn't call {@link com.vaadin.flow.component.upload.ProgressListener}.
     * 
     * If writing to the receiver fails, {@link com.vaadin.flow.component.upload.FailedEvent}
     * is invoked instead of {@link com.vaadin.flow.component.upload.SucceededEvent}, then
     * the exception is re-thrown from this function, so that the test fails properly.
     * 
     * Limitations:
     * 
     * The upload button is not automatically disabled in mocked environment after the max upload file
     *   is reached.
     * The upload "runs" in the UI thread, so there is no way to test thread safety.
     * 
     */
    static void _upload(@NotNull Upload self, @NotNull String fileName,
                        @NotNull String mimeType = URLConnection.guessContentTypeFromName(fileName),
                        @NotNull byte[] file) {
        UploadKt._upload(self, fileName, mimeType, file)
    }

    /**
     * Tests the "upload interrupted" scenario. First invokes
     * {@link com.vaadin.flow.component.upload.StartedEvent}, then polls {@link Upload#getReceiver()}, then
     * fires {@link com.vaadin.flow.component.upload.FailedEvent} and {@link com.vaadin.flow.component.upload.FinishedEvent}.
     * 
     * Currently the implementation simply calls {@link #_uploadFail}.
     */
    static void _uploadInterrupt(@NotNull Upload self, @NotNull String fileName,
                                 @NotNull String mimeType = URLConnection.guessContentTypeFromName(fileName)) {
        UploadKt._uploadInterrupt(self, fileName, mimeType)
    }

    /**
     * Tests the "upload failed" scenario. First invokes
     * {@link com.vaadin.flow.component.upload.StartedEvent}, then polls
     * {@link Upload#getReceiver()} and closes it immediately without writing anything, then
     * fires {@link com.vaadin.flow.component.upload.FailedEvent} with an exception as a reason
     * and then {@link com.vaadin.flow.component.upload.FinishedEvent}.
     */
    static void _uploadFail(@NotNull Upload self, @NotNull String fileName,
                            @NotNull String mimeType = URLConnection.guessContentTypeFromName(fileName),
                            @Nullable Exception exception = null) {
        UploadKt._uploadFail(self, fileName, mimeType, exception)
    }
}