Add GenerateReplayableSequence setting

Author: ferpasri

CHANGELOG

@@ -11,6 +11,7 @@
 - Ignore weak password chrome popup
 - Refactor usage of Tag ScreenshotImage
 - Add settings to configure webdriver constants
+- Add settings to enable/disable generating replayable files
 
 
 #TESTAR 2.7.7 (26-Aug-2025)

testar/src/org/testar/FileHandling.java

@@ -41,23 +41,46 @@
 public class FileHandling {
 
     public static String copyClassifiedSequence(String generatedSequence, File currentSeq, Verdict verdict) {
-        // Generate target folder name based on severity title
+        // Generate the target folder names based on the severity title
         String targetFolder = "sequences_" + verdict.verdictSeverityTitle().toLowerCase();
+        String targetSequence = targetFolder + File.separator + generatedSequence;
 
         LogSerialiser.log(
                 String.format("Copying classified sequence (\"%s\") to %s folder...\n", generatedSequence, targetFolder),
                 LogSerialiser.LogLevel.Info
                 );
 
+        // The .testar sequence file might not exist (e.g., GenerateReplayableSequence is disabled)
+        try {
+            if (!currentSeq.getCanonicalFile().exists()) {
+                LogSerialiser.log(
+                        String.format("No sequence file exists to classify for \"%s\".\n", generatedSequence),
+                        LogSerialiser.LogLevel.Info
+                        );
+
+                LogSerialiser.log(
+                        String.format("No sequence copied to output directory <%s>.\n", targetSequence),
+                        LogSerialiser.LogLevel.Info
+                        );
+
+                return targetSequence;
+            }
+        } catch (IOException ioe) {
+            LogSerialiser.log(
+                    "Error checking whether the sequence file exists: " + ioe.getMessage() + "\n",
+                    LogSerialiser.LogLevel.Critical
+                    );
+        }
+
+        // If it exists, copy to the specific classification folder
         try {
-            // Copy to specific classification folder
             copyToOutputDir(currentSeq, targetFolder);
         } catch (NoSuchTagException | IOException e) {
-            LogSerialiser.log("Error copying classified test sequence: " + e.getMessage() + "\n", LogSerialiser.LogLevel.Critical);
+            LogSerialiser.log("Error copying classified test sequence: " + e.getMessage() + "\n", 
+                    LogSerialiser.LogLevel.Critical
+                    );
         }
 
-        String targetSequence = targetFolder + File.separator + generatedSequence;
-
         LogSerialiser.log(
                 String.format("Copied classified sequence to output <%s> directory!\n", targetSequence),
                 LogSerialiser.LogLevel.Info

testar/src/org/testar/monkey/ConfigTags.java

@@ -234,6 +234,22 @@ private ConfigTags() {}
 	public static final Tag<Boolean> JacocoCoverageAccumulate = Tag.from("JacocoCoverageAccumulate", Boolean.class,
 			"Sets whether Jacoco coverage will be accumulated across the run sequences");
 
+	/**
+	 * Replay settings
+	 */
+
+	public static final Tag<Boolean> GenerateReplayableSequence = Tag.from("GenerateReplayableSequence", Boolean.class,
+			"Sets whether TESTAR must create a replayable testar file during Generate mode (this consumes more memory during execution)");
+
+	public static final Tag<Double> ReplayRetryTime = Tag.from("ReplayRetryTime", Double.class, 
+			"Inside the replay mode, establishes the time window in seconds for trying to replay a UI action of a replayed test sequence");
+
+	public static final Tag<Boolean> UseRecordedActionDurationAndWaitTimeDuringReplay = Tag.from("UseRecordedActionDurationAndWaitTimeDuringReplay", Boolean.class, 
+			"Inside the replay mode sets whether to use the action duration (ActionDuration and TimeToWaitAfterAction) as specified in the generated test sequence");
+
+	public static final Tag<String> PathToReplaySequence = Tag.from("PathToReplaySequence", String.class, 
+			"The sequence to REPLAY is the one indicated in this parameter");
+
 	/**
 	 * Additional settings with descriptions
 	 */
@@ -268,18 +284,12 @@ private ConfigTags() {}
 	public static final Tag<Boolean> OnlySaveFaultySequences = Tag.from("OnlySaveFaultySequences", Boolean.class, 
 			"Sets whether to save test sequences without failures");
 
-	public static final Tag<Double> ReplayRetryTime = Tag.from("ReplayRetryTime", Double.class, 
-			"Inside the replay mode, establishes the time window in seconds for trying to replay a UI action of a replayed test sequence");
-
 	public static final Tag<Boolean> StopGenerationOnFault = Tag.from("StopGenerationOnFault", Boolean.class, 
 			"Sets whether to finish a test in the presence of a fail (e.g. Suspicious Tag detected)");
 
 	public static final Tag<Double> TimeToFreeze = Tag.from("TimeToFreeze", Double.class, 
 			"Sets the time window, in seconds, for which to wait for a not responding SUT. After that, the test will finish with a fail");
 
-	public static final Tag<Boolean> UseRecordedActionDurationAndWaitTimeDuringReplay = Tag.from("UseRecordedActionDurationAndWaitTimeDuringReplay", Boolean.class, 
-			"Inside the replay mode sets whether to use the action duration (ActionDuration and TimeToWaitAfterAction) as specified in the generated test sequence");
-
 	public static final Tag<Boolean> VisualizeActions = Tag.from("VisualizeActions", Boolean.class, 
 			"Sets whether to display overlay information, inside the SPY mode, for all the UI actions derived from the test set up");
 
@@ -289,9 +299,6 @@ private ConfigTags() {}
 	public static final Tag<Boolean> UseSystemActions = Tag.from("UseSystemActions", Boolean.class, 
 			"ANDROID: Indicate if add system calls");
 
-	public static final Tag<String> PathToReplaySequence = Tag.from("PathToReplaySequence", String.class, 
-			"The sequence to REPLAY is the one indicated in this parameter");
-
 	public static final Tag<Double> RefreshSpyCanvas = Tag.from("RefreshSpyCanvas", Double.class, 
 			"Time in milliseconds that indicates the frequency of refreshing the screen in SPY mode");
 

testar/src/org/testar/monkey/DefaultProtocol.java

@@ -457,11 +457,15 @@ void getAndStoreSequenceFile() {
 
 		this.currentSeq = new File(sequenceObject);
 
-		try {
-			TestSerialiser.start(new ObjectOutputStream(new BufferedOutputStream(new FileOutputStream(this.currentSeq, true))));
-			LogSerialiser.log("Created new sequence file!\n", LogSerialiser.LogLevel.Debug);
-		} catch (IOException e) {
-			LogSerialiser.log("I/O exception creating new sequence file\n", LogSerialiser.LogLevel.Critical);
+		if(settings.get(ConfigTags.GenerateReplayableSequence, false)) {
+			try {
+				TestSerialiser.start(new ObjectOutputStream(new BufferedOutputStream(new FileOutputStream(this.currentSeq, true))));
+				LogSerialiser.log("Created new sequence file!\n", LogSerialiser.LogLevel.Info);
+			} catch (IOException e) {
+				LogSerialiser.log("I/O exception creating new sequence file\n", LogSerialiser.LogLevel.Critical);
+			}
+		} else {
+			LogSerialiser.log("Replayable files are not created due to GenerateReplayableSequence setting\n", LogSerialiser.LogLevel.Info);
 		}
 	}
 
@@ -572,6 +576,11 @@ void classifyAndCopySequenceIntoAppropriateDirectory(Verdict finalVerdict){
 	 * @param action
 	 */
 	void saveActionIntoFragmentForReplayableSequence(Action action, State state, Set<Action> actions) {
+	    // User decided not to generate replayable files
+	    if(!settings.get(ConfigTags.GenerateReplayableSequence)) {
+	        return;
+	    }
+
 	    // create fragment
 		TaggableBase fragment = new TaggableBase();
 	    fragment.set(ExecutedAction, action);

testar/src/org/testar/settings/SettingsDefaults.java

@@ -56,6 +56,7 @@ private SettingsDefaults() {}
 		defaults.add(Pair.from(TempDir, Main.tempDir));
 		defaults.add(Pair.from(OnlySaveFaultySequences, false));
 		defaults.add(Pair.from(PathToReplaySequence, Main.tempDir));
+		defaults.add(Pair.from(GenerateReplayableSequence, true));
 		defaults.add(Pair.from(ActionDuration, 0.1));
 		defaults.add(Pair.from(TimeToWaitAfterAction, 0.1));
 		defaults.add(Pair.from(VisualizeActions, false));

testar/src/org/testar/settings/SettingsFileStructure.java

@@ -359,6 +359,19 @@ public static String getTestSettingsStructure() {
 				, ConfigTags.JacocoCoverageClasses.name() + " = "
 				, ConfigTags.JacocoCoverageAccumulate.name() + " = "
 				, ""
+				, "#################################################################"
+				, "# Replay mode features"
+				, "# GenerateReplayableSequence: " + ConfigTags.GenerateReplayableSequence.getDescription()
+				, "# PathToReplaySequence: " + ConfigTags.PathToReplaySequence.getDescription()
+				, "# ReplayRetryTime: " + ConfigTags.ReplayRetryTime.getDescription()
+				, "# UseRecordedActionDurationAndWaitTimeDuringReplay: " + ConfigTags.UseRecordedActionDurationAndWaitTimeDuringReplay.getDescription()
+				, "#################################################################"
+				, ""
+				, ConfigTags.GenerateReplayableSequence.name() + " = "
+				, ConfigTags.PathToReplaySequence.name() + " = "
+				, ConfigTags.ReplayRetryTime.name() + " = "
+				, ConfigTags.UseRecordedActionDurationAndWaitTimeDuringReplay.name() + " = "
+				, ""
 				);
 
 		// Second, create a list of secondary configuration tags settings
@@ -371,12 +384,9 @@ public static String getTestSettingsStructure() {
 		secondarySettingsList.add(ConfigTags.FormFillingAction);
 		secondarySettingsList.add(ConfigTags.LogLevel);
 		secondarySettingsList.add(ConfigTags.OnlySaveFaultySequences);
-		secondarySettingsList.add(ConfigTags.ReplayRetryTime);
 		secondarySettingsList.add(ConfigTags.StopGenerationOnFault);
 		secondarySettingsList.add(ConfigTags.TimeToFreeze);
-		secondarySettingsList.add(ConfigTags.UseRecordedActionDurationAndWaitTimeDuringReplay);
 		secondarySettingsList.add(ConfigTags.UseSystemActions);
-		secondarySettingsList.add(ConfigTags.PathToReplaySequence);
 		secondarySettingsList.add(ConfigTags.RefreshSpyCanvas);
 		secondarySettingsList.add(ConfigTags.FlashFeedback);
 		secondarySettingsList.add(ConfigTags.MaxReward);