-
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.
Merge pull request #39 from WhiteOrganization/recording-upgrade
Recoding functionality Improvements
- Loading branch information
Showing
4 changed files
with
112 additions
and
64 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
100 changes: 100 additions & 0 deletions
100
src/main/java/org/white_sdev/white_seleniumframework/framework/RecordingUtils.java
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,100 @@ | ||
| package org.white_sdev.white_seleniumframework.framework; | ||
|
|
||
|
|
||
| import io.github.bonigarcia.seljup.SeleniumJupiter; | ||
| import lombok.SneakyThrows; | ||
| import org.apache.commons.io.FileUtils; | ||
| import org.white_sdev.white_seleniumframework.exceptions.White_SeleniumFrameworkException; | ||
|
|
||
| import java.io.File; | ||
| import java.nio.file.NoSuchFileException; | ||
| import java.time.LocalDate; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| @lombok.extern.slf4j.Slf4j | ||
| public class RecordingUtils { | ||
|
|
||
| public static String startRecording(SeleniumJupiter seleniumJupiter, String displayName){ | ||
| String logID="::startRecording([seleniumJupiter, displayName]): "; | ||
| log.trace("{}Start ", logID); | ||
| Objects.requireNonNull(seleniumJupiter); | ||
| if(displayName == null) displayName = "recorded"; | ||
| try{ | ||
|
|
||
| String recordedFileName = getFileName(displayName); | ||
| seleniumJupiter.startRecording(recordedFileName); | ||
| log.trace("{}Finish", logID); | ||
| return recordedFileName; | ||
|
|
||
| } catch (Exception ex) { | ||
| throw new White_SeleniumFrameworkException("Impossible to start the recording", ex); | ||
| } | ||
| } | ||
|
|
||
| public static Optional<File> saveRecording(SeleniumJupiter seleniumJupiter, String displayName){ | ||
| return saveRecording(seleniumJupiter, displayName, null, null); | ||
| } | ||
|
|
||
| @SneakyThrows | ||
| public static Optional<File> saveRecording(SeleniumJupiter seleniumJupiter, String displayName, String filePath, String fileName){ | ||
| String logID="::saveRecording([seleniumJupiter, displayName, filePath, fileName]): "; | ||
| log.trace("{}Start ", logID); | ||
| Objects.requireNonNull(seleniumJupiter); | ||
| if(displayName == null) displayName = "recorded"; | ||
| if(filePath == null) filePath = "target/test-reports/recorded/"; | ||
| try { | ||
|
|
||
| final int REC_TIMEOUT_SEC = 4; | ||
| final int POLL_TIME_MSEC = 100; | ||
|
|
||
| seleniumJupiter.stopRecording(); | ||
|
|
||
| long timeoutMs = System.currentTimeMillis() + TimeUnit.SECONDS.toMillis(REC_TIMEOUT_SEC); | ||
|
|
||
| File recFile; | ||
| do { | ||
| recFile = getRecordedFile(displayName); | ||
| if (System.currentTimeMillis() > timeoutMs) { | ||
| log.error("Timeout of " + REC_TIMEOUT_SEC + " seconds waiting for recording " + recFile); | ||
| break; | ||
| } | ||
| Thread.sleep(POLL_TIME_MSEC); | ||
|
|
||
| } while (!recFile.exists()); | ||
|
|
||
| log.debug("{}Recorded File Status: {}", logID, recFile.exists()); | ||
| log.debug("{}File Name: {}", logID, recFile.getAbsolutePath()); | ||
| if (recFile.exists()) { | ||
| File movedFile =new File(filePath + (fileName!=null? fileName: recFile.getName())); | ||
| try { | ||
| log.trace("{}Removing file if a previous one was already in the directory.", logID); | ||
| FileUtils.delete(movedFile); | ||
| } catch (NoSuchFileException ex) { | ||
| log.trace("{}No previous file found, proceeding with happy path.", logID); | ||
| } | ||
| FileUtils.moveFile(recFile, movedFile); | ||
| return Optional.of(movedFile); | ||
| }else{ | ||
| log.error(logID+"Impossible to save the file. Are you '@Watch'ing your WebDriver?"); | ||
| return Optional.empty(); | ||
| } | ||
| }catch(Exception ex){ | ||
| throw new White_SeleniumFrameworkException("An error occurred when saving the video recording.", ex); | ||
| } | ||
| } | ||
|
|
||
| public static File getRecordedFile(String displayName){ | ||
| final String RECORDED_EXT = ".webm"; | ||
| String recordedFileName = getFileName(displayName) + RECORDED_EXT; | ||
| final String RECORDED_FOLDER_PATH = System.getProperty("user.home") + "/Downloads"; //TODO this will probably throw an exception in other SO out of Windows. | ||
| File targetFolder = new File(RECORDED_FOLDER_PATH); | ||
|
|
||
| return new File(targetFolder, recordedFileName); | ||
| } | ||
|
|
||
| public static String getFileName(String displayName){ | ||
| return displayName + " " + LocalDate.now().toString().replace(":| ", "_"); | ||
| } | ||
| } |
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