Test cases, fixtures and data sources : Download only if we don't have most recent copy and don't load if marked deleted

1. We load all the fixtures, test casess and test data source when opening a specific version of automation project. We don't want to download data if we already have the most recent version. Each version of automation project will have a lastsupdated file that stores a universal datetime for when was this version updated last. We will pass on this value to service to return only those data that have been modified after this datetime.
2. If a fixture or test case or test data source is deleted, we don't want to load it next time the project is loaded. To achieve this , we now have a IsDeleted flag on fixtures, test cases and test data source. Deleted fixtures, test cases and test data source are still retrieve from server so that we have the latest state indicating if they have been marked as deleted. However, test explorer and test data repository will skip creating a view model for these to show them.

Author: Nfactor26

src/Pixel.Automation.Core/Constants.cs

@@ -99,14 +99,7 @@ public static class Constants
         /// </summary>
         public static readonly string ApplicationsMeta = "Applications.meta";
 
-        /// <summary>
-        /// Meta data file name for projects
-        /// </summary>
-        public static readonly string ProjectsMeta = "Projects.meta";
-
-        /// <summary>
-        /// Meta data file name for project versions
-        /// </summary>
-        public static readonly string VersionsMeta = "Versions.meta";
+        public static readonly string LastUpdatedFileName = "lastupdated";
+     
     }
 }

src/Pixel.Automation.Core/FileSystem/ProjectFileSystem.cs

@@ -96,6 +96,10 @@ public IEnumerable<TestDataSource> GetTestDataSources()
             foreach (var dataSourceFile in dataSourceFiles)
             {
                 var testDataSource = serializer.Deserialize<TestDataSource>(dataSourceFile);
+                if(testDataSource.IsDeleted)
+                {
+                    continue;
+                }
                 yield return testDataSource;              
             }
             yield break;

src/Pixel.Automation.Core/TestData/TestCase.cs

@@ -1,6 +1,7 @@
 using Pixel.Automation.Core.Attributes;
 using Pixel.Automation.Core.Enums;
 using System;
+using System.Diagnostics.SymbolStore;
 using System.Runtime.Serialization;
 using System.Text.Json.Serialization;
 
@@ -81,6 +82,12 @@ public class TestCase : ICloneable
         [DataMember(IsRequired = true, Order = 110)]
         public TagCollection Tags { get; private set; } = new TagCollection();
 
+        /// <summary>
+        /// Indicates if the TestCase is deleted. Deleted test cases are not loaded in explorer.
+        /// </summary>
+        [DataMember(IsRequired = false, Order = 1000)]
+        public bool IsDeleted { get; set; }
+
         /// <summary>
         /// Root entity for the test case
         /// </summary>

src/Pixel.Automation.Core/TestData/TestDataSource.cs

@@ -40,6 +40,13 @@ public class TestDataSource
         /// </summary>
         [DataMember(IsRequired = true, Order = 50)]
         public DataSourceConfiguration MetaData { get; set; }
+
+
+        /// <summary>
+        /// Indicates if the TestDataSource is deleted. Deleted data sources are not loaded in explorer.
+        /// </summary>
+        [DataMember(IsRequired = false, Order = 1000)]
+        public bool IsDeleted { get; set; }
     }
 
     /// <summary>

src/Pixel.Automation.Core/TestData/TestFixture.cs

@@ -66,6 +66,12 @@ public class TestFixture
         [DataMember(IsRequired = true, Order = 90)]
         public TagCollection Tags { get; private set; } = new TagCollection();
 
+        /// <summary>
+        /// Indicates if the fixture was deleted. Deleted fixtures are not loaded in explorer.
+        /// </summary>
+        [DataMember(IsRequired = false, Order = 1000)]
+        public bool IsDeleted { get; set; }
+
         /// <summary>
         /// Collection of tests belonging to a fixture 
         /// </summary>

src/Pixel.Automation.TestExplorer.ViewModels/TestExplorerViewModel.cs

@@ -118,12 +118,20 @@ async Task LoadDataAsync()
                     foreach (var testFixtureDirectory in Directory.GetDirectories(this.fileSystem.TestCaseRepository))
                     {
                         var testFixture = this.fileSystem.LoadFiles<TestFixture>(testFixtureDirectory).Single();
+                        if(testFixture.IsDeleted)
+                        {
+                            continue; 
+                        }
                         TestFixtureViewModel testFixtureVM = new TestFixtureViewModel(testFixture);
                         this.TestFixtures.Add(testFixtureVM);
 
                         foreach (var testCaseDirectory in Directory.GetDirectories(Path.Combine(this.fileSystem.TestCaseRepository, testFixture.FixtureId)))
                         {
                             var testCase = this.fileSystem.LoadFiles<TestCase>(testCaseDirectory).Single();
+                            if(testCase.IsDeleted)
+                            {
+                                continue;
+                            }
                             TestCaseViewModel testCaseVM = new TestCaseViewModel(testCase);
                             testFixtureVM.Tests.Add(testCaseVM);
                         }

src/Pixel.Persistence.Respository/Interfaces/ITestCaseRepository.cs

@@ -1,4 +1,5 @@
 using Pixel.Persistence.Core.Models;
+using System;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
@@ -8,13 +9,13 @@ namespace Pixel.Persistence.Respository.Interfaces;
 public interface ITestCaseRepository
 {
     /// <summary>
-    /// Get all test cases for a given project version
+    /// Get all test cases for a given project version which were modified after specified datetime
     /// </summary>
     /// <param name="projectId"></param>
     /// <param name="projectVersion"></param>
     /// <param name="cancellationToken"></param>
     /// <returns></returns>
-    Task<IEnumerable<TestCase>> GetTestCasesAsync(string projectId, string projectVersion, CancellationToken cancellationToken);
+    Task<IEnumerable<TestCase>> GetTestCasesAsync(string projectId, string projectVersion, DateTime laterThan, CancellationToken cancellationToken);
 
     /// <summary>
     /// Get test cases by Id for a given version of project

src/Pixel.Persistence.Respository/Interfaces/ITestDataRepository.cs

@@ -1,4 +1,5 @@
 using Pixel.Persistence.Core.Models;
+using System;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
@@ -8,62 +9,63 @@ namespace Pixel.Persistence.Respository.Interfaces
     public interface ITestDataRepository
     {
         /// <summary>
-        /// Add a TestDataSource to a given version of project
+        /// Get TestDataSource by Id for a given version of project
         /// </summary>
-        /// <param name="dataSource"></param>
+        /// <param name="projectId"></param>
+        /// <param name="projectVersion"></param>
+        /// <param name="fixtureId"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task AddDataSourceAsync(string projectId, string projectVersion, TestDataSource dataSource, CancellationToken cancellationToken);
+        Task<TestDataSource> FindByIdAsync(string projectId, string projectVersion, string fixtureId, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Add multiple TestDataSources to a given version of project
+        /// Get TestDataSource by name for a given version of project
         /// </summary>
         /// <param name="projectId"></param>
         /// <param name="projectVersion"></param>
-        /// <param name="dataSources"></param>
+        /// <param name="name"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task AddDataSourcesAsync(string projectId, string projectVersion, IEnumerable<TestDataSource> dataSources, CancellationToken cancellationToken);
+        Task<TestDataSource> FindByNameAsync(string projectId, string projectVersion, string name, CancellationToken cancellationToken);
 
         /// <summary>
-        /// Delete an existing TestDataSource for a given version of project
+        /// Get all the TestDataSources available for a given version of project that were modified since specified datetime
         /// </summary>
         /// <param name="projectId"></param>
         /// <param name="projectVersion"></param>
-        /// <param name="dataSourceId"></param>
+        /// <param name="laterThan"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task DeleteDataSourceAsync(string projectId, string projectVersion, string dataSourceId, CancellationToken cancellationToken);
-       
+        Task<IEnumerable<TestDataSource>> GetDataSourcesAsync(string projectId, string projectVersion, DateTime laterThan, CancellationToken cancellationToken);
+
         /// <summary>
-        /// Get TestDataSource by Id for a given version of project
+        /// Add a TestDataSource to a given version of project
         /// </summary>
-        /// <param name="projectId"></param>
-        /// <param name="projectVersion"></param>
-        /// <param name="fixtureId"></param>
+        /// <param name="dataSource"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<TestDataSource> FindByIdAsync(string projectId, string projectVersion, string fixtureId, CancellationToken cancellationToken);
-       
+        Task AddDataSourceAsync(string projectId, string projectVersion, TestDataSource dataSource, CancellationToken cancellationToken);
+
         /// <summary>
-        /// Get TestDataSource by name for a given version of project
+        /// Add multiple TestDataSources to a given version of project
         /// </summary>
         /// <param name="projectId"></param>
         /// <param name="projectVersion"></param>
-        /// <param name="name"></param>
+        /// <param name="dataSources"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<TestDataSource> FindByNameAsync(string projectId, string projectVersion, string name, CancellationToken cancellationToken);
-        
+        Task AddDataSourcesAsync(string projectId, string projectVersion, IEnumerable<TestDataSource> dataSources, CancellationToken cancellationToken);
+
         /// <summary>
-        /// Get all the TestDataSources available for a given version of project
+        /// Delete an existing TestDataSource for a given version of project
         /// </summary>
         /// <param name="projectId"></param>
         /// <param name="projectVersion"></param>
+        /// <param name="dataSourceId"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<IEnumerable<TestDataSource>> GetDataSourcesAsync(string projectId, string projectVersion, CancellationToken cancellationToken);
-      
+        Task DeleteDataSourceAsync(string projectId, string projectVersion, string dataSourceId, CancellationToken cancellationToken);   
+             
         /// <summary>
         /// Update a TestDataSource for a given version of project
         /// </summary>

src/Pixel.Persistence.Respository/Interfaces/ITestFixtureRepository.cs

@@ -9,12 +9,13 @@ namespace Pixel.Persistence.Respository.Interfaces;
 public interface ITestFixtureRepository
 {
     /// <summary>
-    /// Get all test fixtures for a given project version
+    /// Get all test fixtures for a given project version which have been modified since specified datetime
     /// </summary>
     /// <param name="projectId">Identifier of the automation project</param>
     /// <param name="projectVersion">Version of the automation project</param>
     /// <returns></returns>
-    Task<IEnumerable<TestFixture>> GetFixturesAsync(string projectId, string projectVersion, CancellationToken cancellationToken);
+    Task<IEnumerable<TestFixture>> GetFixturesAsync(string projectId, string projectVersion, DateTime laterThan, CancellationToken cancellationToken);
+
 
     /// <summary>
     /// Get a test fixture given it's Id

src/Pixel.Persistence.Respository/ProjectsRepository.cs

@@ -105,21 +105,23 @@ public async Task AddProjectVersionAsync(string projectId, ProjectVersion newVer
             projectReference.Id = ObjectId.Empty;
             await this.referencesRepository.AddProjectReferences(projectId, newVersion.ToString(), projectReference);
 
-            var fixtures = await this.fixturesRepository.GetFixturesAsync(projectId, cloneFrom.ToString(), cancellationToken);
+
+            DateTime laterThan = DateTime.MinValue.ToUniversalTime();
+            var fixtures = await this.fixturesRepository.GetFixturesAsync(projectId, cloneFrom.ToString(), laterThan, cancellationToken);
             foreach(var fixture in fixtures)
             {
                 fixture.Id = ObjectId.Empty;
             }
             await this.fixturesRepository.AddFixturesAsync(projectId, newVersion.ToString(), fixtures, cancellationToken);
 
-            var tests = await this.testCaseRepository.GetTestCasesAsync(projectId, cloneFrom.ToString(), cancellationToken);
+            var tests = await this.testCaseRepository.GetTestCasesAsync(projectId, cloneFrom.ToString(), laterThan, cancellationToken);
             foreach(var test in tests)
             {
                 test.Id = ObjectId.Empty;
             }
             await this.testCaseRepository.AddTestCasesAsync(projectId, newVersion.ToString(), tests, cancellationToken);
 
-            var dataSources = await this.testDataRepository.GetDataSourcesAsync(projectId, cloneFrom.ToString(), cancellationToken);
+            var dataSources = await this.testDataRepository.GetDataSourcesAsync(projectId, cloneFrom.ToString(), laterThan, cancellationToken);
             foreach(var dataSource in dataSources)
             {
                 dataSource.Id = ObjectId.Empty;