Skip to content

Avoid overwriting by moving old file to backup #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Avoid overwriting by moving old file to backup #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f14dc4f
FileSaver backup session dir if session dir already exists
ahmed-shariff Dec 12, 2022
7b8a450
Tests for backing up session files it they exist
ahmed-shariff Dec 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 42 additions & 5 deletions Assets/UXF/Scripts/DataHandling/FileSaver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
using System.Collections;
using System.Collections.Generic;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Events;
using System;
using System.IO;
using System.Threading;
using System.Linq;
using System.Globalization;

namespace UXF
Expand All @@ -32,6 +29,16 @@ public class FileSaver : LocalFileDataHander
[Tooltip("Enable to print debug messages to the console.")]
public bool verboseDebug = false;

/// <summary>
/// Enable backing up the session directory if it already exists when a session starts. If
/// not true, this will overwrite the is the UXF runs with the same experiment name, ppid,
/// and session number again.
/// </summary>
[Tooltip("Enable backing up the session directory if it already exists when a session starts. If" +
"not true, this will overwrite the is the UXF runs with the same experiment name, ppid," +
"and session number again.")]
public bool backupSessionIfExists = true;

/// <summary>
/// An action which does nothing.
/// </summary>
Expand All @@ -46,7 +53,6 @@ public class FileSaver : LocalFileDataHander

bool quitting = false;


/// <summary>
/// Starts the FileSaver Worker thread.
/// </summary>
Expand All @@ -59,6 +65,37 @@ public override void SetUp()

quitting = false;
Directory.CreateDirectory(base.StoragePath);
string sessionDirectory = GetSessionPath(session.experimentName, session.ppid, session.number);
if (Directory.Exists(sessionDirectory))
{
Utilities.UXFDebugLogWarning($"Session directory {sessionDirectory} already exists.");
if (backupSessionIfExists)
{
string suffix = Directory.GetLastWriteTime(sessionDirectory).ToString("dd-MM-yyyy-HH-mm-FF");
string backupSessionDirectory = $"{sessionDirectory}_{suffix}";

int idx = 1;
while (Directory.Exists(backupSessionDirectory))
{
backupSessionDirectory = $"{backupSessionDirectory}_{idx}";
}

try
{
Directory.Move(sessionDirectory, backupSessionDirectory);
Utilities.UXFDebugLogWarning($"Trying to backup {sessionDirectory} to {backupSessionDirectory}.");
}
catch(Exception e)
{
Utilities.UXFDebugLogError($"Failed to backup {sessionDirectory} to {backupSessionDirectory} with exception ({e}): {e.Message}");
throw e;
}
}
else
{
Utilities.UXFDebugLogWarning($"backupSessionIfExists is False. Content in {sessionDirectory} may be overwritten.");
}
}

if (!IsActive)
{
Expand Down
82 changes: 82 additions & 0 deletions Assets/UXF/Tests/Editor/TestFileIOManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,20 @@ public class TestFileSaver
string ppid = "test_ppid";
int sessionNum = 1;
FileSaver fileSaver;
Session session;

[SetUp]
public void SetUp()
{
var gameObject = new GameObject();
fileSaver = gameObject.AddComponent<FileSaver>();
fileSaver.verboseDebug = true;
if (Session.instance != null) GameObject.DestroyImmediate(Session.instance.gameObject);
session = gameObject.AddComponent<Session>();
session.experimentName = "test_experiment";
session.ppid = "P001";
session.number = 1;
fileSaver.Initialise(session);
}


Expand Down Expand Up @@ -149,5 +156,80 @@ public void FileSaverRelPath()
SystemInfo.operatingSystemFamily == OperatingSystemFamily.Windows ? "123" : "../123"
);
}

[Test]
public void TestBackupSession()
{
fileSaver.StoragePath = "test_output";
fileSaver.backupSessionIfExists = true;
if (Directory.Exists(fileSaver.StoragePath))
{
Directory.Delete(fileSaver.StoragePath, true);
}

fileSaver.SetUp();

string fileName = "testMoveToBackup";
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);

fileSaver.CleanUp();
System.Threading.Thread.Sleep(500);

fileSaver.SetUp();

fileName = "testMoveToBackup";
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);

fileSaver.CleanUp();

string testFilesDirectory = fileSaver.GetSessionPath(session.experimentName, session.ppid, session.number);

string[] directories = Directory.GetDirectories(Directory.GetParent(testFilesDirectory).ToString(), $"{FileSaver.SessionNumToName(1)}*", SearchOption.TopDirectoryOnly);
Assert.AreEqual(directories.Length, 2);

Directory.Delete(fileSaver.StoragePath, true);
}

[Test]
public void TestSessionOverwrite()
{
fileSaver.StoragePath = "test_output";
fileSaver.backupSessionIfExists = false;
if (Directory.Exists(fileSaver.StoragePath))
{
Directory.Delete(fileSaver.StoragePath, true);
}

fileSaver.SetUp();

string fileName = "testMoveToBackup";
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);

fileSaver.CleanUp();
System.Threading.Thread.Sleep(500);

fileSaver.SetUp();

fileName = "testMoveToBackup";
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);
fileSaver.HandleText("", session.experimentName, session.ppid, session.number, fileName, UXFDataType.TrialResults);

fileSaver.CleanUp();

string testFilesDirectory = fileSaver.GetSessionPath(session.experimentName, session.ppid, session.number);

string[] directories = Directory.GetDirectories(Directory.GetParent(testFilesDirectory).ToString(), $"{FileSaver.SessionNumToName(1)}*", SearchOption.TopDirectoryOnly);
Assert.AreEqual(directories.Length, 1);

Directory.Delete(fileSaver.StoragePath, true);
}
}

}