Skyline: Fixed broken TestPerf tutorial audit log names (#3320)

- Added test mode that very quickly checks audit logs are named correctly
ProteoWizard · Jan 5, 2025 · aa14e94 · aa14e94
1 parent 639d03e
commit aa14e94
Show file tree

Hide file tree

Showing 36 changed files with 33 additions and 5 deletions.
diff --git a/...ditLogs/en/TestDiaQeDiaUmpireTutorial.log → ...gs/en/TestDiaQeDiaUmpireTutorialExtra.log b/...ditLogs/en/TestDiaQeDiaUmpireTutorial.log → ...gs/en/TestDiaQeDiaUmpireTutorialExtra.log
diff --git a/...itLogs/en/TestDiaQeFullSearchTutorial.log → ...s/en/TestDiaQeFullSearchTutorialExtra.log b/...itLogs/en/TestDiaQeFullSearchTutorial.log → ...s/en/TestDiaQeFullSearchTutorialExtra.log
diff --git a/...lAuditLogs/en/TestDiaSearchQeTutorial.log → ...tLogs/en/TestDiaSearchQeTutorialDraft.log b/...lAuditLogs/en/TestDiaSearchQeTutorial.log → ...tLogs/en/TestDiaSearchQeTutorialDraft.log
diff --git a/...tLogs/en/TestDiaSearchStellarTutorial.log → .../en/TestDiaSearchStellarTutorialDraft.log b/...tLogs/en/TestDiaSearchStellarTutorial.log → .../en/TestDiaSearchStellarTutorialDraft.log
diff --git a/...Logs/en/TestDiaTtofFullSearchTutorial.log → ...en/TestDiaTtofFullSearchTutorialExtra.log b/...Logs/en/TestDiaTtofFullSearchTutorial.log → ...en/TestDiaTtofFullSearchTutorialExtra.log
diff --git a/...ogs/en/TestEncyclopeDiaSearchTutorial.log → ...n/TestEncyclopeDiaSearchTutorialDraft.log b/...ogs/en/TestEncyclopeDiaSearchTutorial.log → ...n/TestEncyclopeDiaSearchTutorialDraft.log
diff --git a/...orialAuditLogs/en/TestOrbiPrmTutorial.log → ...AuditLogs/en/TestOrbiPrmTutorialDraft.log b/...orialAuditLogs/en/TestOrbiPrmTutorial.log → ...AuditLogs/en/TestOrbiPrmTutorialDraft.log
diff --git a/...ditLogs/fr/TestDiaQeDiaUmpireTutorial.log → ...gs/fr/TestDiaQeDiaUmpireTutorialExtra.log b/...ditLogs/fr/TestDiaQeDiaUmpireTutorial.log → ...gs/fr/TestDiaQeDiaUmpireTutorialExtra.log
diff --git a/...itLogs/fr/TestDiaQeFullSearchTutorial.log → ...s/fr/TestDiaQeFullSearchTutorialExtra.log b/...itLogs/fr/TestDiaQeFullSearchTutorial.log → ...s/fr/TestDiaQeFullSearchTutorialExtra.log
diff --git a/...lAuditLogs/fr/TestDiaSearchQeTutorial.log → ...tLogs/fr/TestDiaSearchQeTutorialDraft.log b/...lAuditLogs/fr/TestDiaSearchQeTutorial.log → ...tLogs/fr/TestDiaSearchQeTutorialDraft.log
diff --git a/...tLogs/fr/TestDiaSearchStellarTutorial.log → .../fr/TestDiaSearchStellarTutorialDraft.log b/...tLogs/fr/TestDiaSearchStellarTutorial.log → .../fr/TestDiaSearchStellarTutorialDraft.log
diff --git a/...Logs/fr/TestDiaTtofFullSearchTutorial.log → ...fr/TestDiaTtofFullSearchTutorialExtra.log b/...Logs/fr/TestDiaTtofFullSearchTutorial.log → ...fr/TestDiaTtofFullSearchTutorialExtra.log
diff --git a/...ogs/fr/TestEncyclopeDiaSearchTutorial.log → ...r/TestEncyclopeDiaSearchTutorialDraft.log b/...ogs/fr/TestEncyclopeDiaSearchTutorial.log → ...r/TestEncyclopeDiaSearchTutorialDraft.log
diff --git a/...orialAuditLogs/fr/TestOrbiPrmTutorial.log → ...AuditLogs/fr/TestOrbiPrmTutorialDraft.log b/...orialAuditLogs/fr/TestOrbiPrmTutorial.log → ...AuditLogs/fr/TestOrbiPrmTutorialDraft.log
diff --git a/...ditLogs/ja/TestDiaQeDiaUmpireTutorial.log → ...gs/ja/TestDiaQeDiaUmpireTutorialExtra.log b/...ditLogs/ja/TestDiaQeDiaUmpireTutorial.log → ...gs/ja/TestDiaQeDiaUmpireTutorialExtra.log
diff --git a/...itLogs/ja/TestDiaQeFullSearchTutorial.log → ...s/ja/TestDiaQeFullSearchTutorialExtra.log b/...itLogs/ja/TestDiaQeFullSearchTutorial.log → ...s/ja/TestDiaQeFullSearchTutorialExtra.log
diff --git a/...lAuditLogs/ja/TestDiaSearchQeTutorial.log → ...tLogs/ja/TestDiaSearchQeTutorialDraft.log b/...lAuditLogs/ja/TestDiaSearchQeTutorial.log → ...tLogs/ja/TestDiaSearchQeTutorialDraft.log
diff --git a/...tLogs/ja/TestDiaSearchStellarTutorial.log → .../ja/TestDiaSearchStellarTutorialDraft.log b/...tLogs/ja/TestDiaSearchStellarTutorial.log → .../ja/TestDiaSearchStellarTutorialDraft.log
diff --git a/...Logs/ja/TestDiaTtofFullSearchTutorial.log → ...ja/TestDiaTtofFullSearchTutorialExtra.log b/...Logs/ja/TestDiaTtofFullSearchTutorial.log → ...ja/TestDiaTtofFullSearchTutorialExtra.log
diff --git a/...ogs/ja/TestEncyclopeDiaSearchTutorial.log → ...a/TestEncyclopeDiaSearchTutorialDraft.log b/...ogs/ja/TestEncyclopeDiaSearchTutorial.log → ...a/TestEncyclopeDiaSearchTutorialDraft.log
diff --git a/...orialAuditLogs/ja/TestOrbiPrmTutorial.log → ...AuditLogs/ja/TestOrbiPrmTutorialDraft.log b/...orialAuditLogs/ja/TestOrbiPrmTutorial.log → ...AuditLogs/ja/TestOrbiPrmTutorialDraft.log
diff --git a/...ditLogs/tr/TestDiaQeDiaUmpireTutorial.log → ...gs/tr/TestDiaQeDiaUmpireTutorialExtra.log b/...ditLogs/tr/TestDiaQeDiaUmpireTutorial.log → ...gs/tr/TestDiaQeDiaUmpireTutorialExtra.log
diff --git a/...itLogs/tr/TestDiaQeFullSearchTutorial.log → ...s/tr/TestDiaQeFullSearchTutorialExtra.log b/...itLogs/tr/TestDiaQeFullSearchTutorial.log → ...s/tr/TestDiaQeFullSearchTutorialExtra.log
diff --git a/...lAuditLogs/tr/TestDiaSearchQeTutorial.log → ...tLogs/tr/TestDiaSearchQeTutorialDraft.log b/...lAuditLogs/tr/TestDiaSearchQeTutorial.log → ...tLogs/tr/TestDiaSearchQeTutorialDraft.log
diff --git a/...tLogs/tr/TestDiaSearchStellarTutorial.log → .../tr/TestDiaSearchStellarTutorialDraft.log b/...tLogs/tr/TestDiaSearchStellarTutorial.log → .../tr/TestDiaSearchStellarTutorialDraft.log
diff --git a/...Logs/tr/TestDiaTtofFullSearchTutorial.log → ...tr/TestDiaTtofFullSearchTutorialExtra.log b/...Logs/tr/TestDiaTtofFullSearchTutorial.log → ...tr/TestDiaTtofFullSearchTutorialExtra.log
diff --git a/...ogs/tr/TestEncyclopeDiaSearchTutorial.log → ...r/TestEncyclopeDiaSearchTutorialDraft.log b/...ogs/tr/TestEncyclopeDiaSearchTutorial.log → ...r/TestEncyclopeDiaSearchTutorialDraft.log
diff --git a/...orialAuditLogs/tr/TestOrbiPrmTutorial.log → ...AuditLogs/tr/TestOrbiPrmTutorialDraft.log b/...orialAuditLogs/tr/TestOrbiPrmTutorial.log → ...AuditLogs/tr/TestOrbiPrmTutorialDraft.log
diff --git a/...ditLogs/zh/TestDiaQeDiaUmpireTutorial.log → ...gs/zh/TestDiaQeDiaUmpireTutorialExtra.log b/...ditLogs/zh/TestDiaQeDiaUmpireTutorial.log → ...gs/zh/TestDiaQeDiaUmpireTutorialExtra.log
diff --git a/...itLogs/zh/TestDiaQeFullSearchTutorial.log → ...s/zh/TestDiaQeFullSearchTutorialExtra.log b/...itLogs/zh/TestDiaQeFullSearchTutorial.log → ...s/zh/TestDiaQeFullSearchTutorialExtra.log
diff --git a/...lAuditLogs/zh/TestDiaSearchQeTutorial.log → ...tLogs/zh/TestDiaSearchQeTutorialDraft.log b/...lAuditLogs/zh/TestDiaSearchQeTutorial.log → ...tLogs/zh/TestDiaSearchQeTutorialDraft.log
diff --git a/...tLogs/zh/TestDiaSearchStellarTutorial.log → .../zh/TestDiaSearchStellarTutorialDraft.log b/...tLogs/zh/TestDiaSearchStellarTutorial.log → .../zh/TestDiaSearchStellarTutorialDraft.log
diff --git a/...Logs/zh/TestDiaTtofFullSearchTutorial.log → ...zh/TestDiaTtofFullSearchTutorialExtra.log b/...Logs/zh/TestDiaTtofFullSearchTutorial.log → ...zh/TestDiaTtofFullSearchTutorialExtra.log
diff --git a/...ogs/zh/TestEncyclopeDiaSearchTutorial.log → ...h/TestEncyclopeDiaSearchTutorialDraft.log b/...ogs/zh/TestEncyclopeDiaSearchTutorial.log → ...h/TestEncyclopeDiaSearchTutorialDraft.log
diff --git a/...orialAuditLogs/zh/TestOrbiPrmTutorial.log → ...AuditLogs/zh/TestOrbiPrmTutorialDraft.log b/...orialAuditLogs/zh/TestOrbiPrmTutorial.log → ...AuditLogs/zh/TestOrbiPrmTutorialDraft.log
diff --git a/pwiz_tools/Skyline/TestUtil/TestFunctional.cs b/pwiz_tools/Skyline/TestUtil/TestFunctional.cs
@@ -1391,6 +1391,8 @@ public bool IsRecordAuditLogForTutorials
             get { return IsTutorial && RecordAuditLogs; }
         }
 
+        public bool IsTestAuditLogPlacement => false;
+
         public static bool IsShowMatchingTutorialPages { get; set; }
 
         public static bool IsDemoMode { get { return Program.DemoMode; } }
@@ -1963,6 +1965,12 @@ protected void RunFunctionalTest(string defaultUiMode = UiModes.PROTEOMIC)
             {
                 return; // Don't want to run this lengthy test right now
             }
+            if (IsTestAuditLogPlacement)
+            {
+                // Just testing if audit logs are where they are expected to be
+                AssertAuditLogCorrectlyPlaced();
+                return;
+            }
 
             RunFunctionalTestAttempt(defaultUiMode);
 
@@ -2174,16 +2182,14 @@ private void VerifyAuditLogCorrect()
                 return;
 
             // Ensure expected tutorial log file exists unless recording
-            var projectFile = GetLogFilePath(AuditLogTutorialDir);
-            bool existsInProject = File.Exists(projectFile);
             if (!IsRecordAuditLogForTutorials)
             {
-                Assert.IsTrue(existsInProject,
-                    "Log file for test \"{0}\" does not exist at \"{1}\", set IsRecordAuditLogForTutorials=true to create it",
-                    TestContext.TestName, projectFile);
+                AssertProjectLogFileExists();
             }
 
             // Compare file contents
+            var projectFile = GetLogFilePath(AuditLogTutorialDir);
+            bool existsInProject = File.Exists(projectFile);
             var expected = existsInProject ? ReadTextWithNormalizedLineEndings(projectFile) : string.Empty;
             var actual = ReadTextWithNormalizedLineEndings(recordedFile);
             if (AreEquivalentAuditLogs(expected, actual))
@@ -2233,6 +2239,28 @@ private void VerifyAuditLogCorrect()
             }
         }
 
+        private void AssertAuditLogCorrectlyPlaced()
+        {
+            if (AuditLogCompareLogs)
+            {
+                AssertProjectLogFileExists();
+
+                Console.Write(@" found audit log ");
+            }
+            else
+            {
+                Console.Write(@" no audit log comparison ");
+            }
+        }
+
+        private void AssertProjectLogFileExists()
+        {
+            var projectFile = GetLogFilePath(AuditLogTutorialDir);
+            Assert.IsTrue(File.Exists(projectFile),
+                "Log file for test \"{0}\" does not exist at \"{1}\", set IsRecordAuditLogForTutorials=true to create it",
+                TestContext.TestName, projectFile);
+        }
+
         private static bool AreEquivalentAuditLogs(string expected, string actual)
         {
             try