initial commit (Azure#50554)

Author: nickliu-msft

sdk/storage/Azure.Storage.DataMovement.Blobs/src/BlobDestinationCheckpointDetails.cs

@@ -304,7 +304,8 @@ internal static BlobDestinationCheckpointDetails Deserialize(Stream stream)
 
             // Version
             int version = reader.ReadInt32();
-            if (version != DataMovementBlobConstants.DestinationCheckpointDetails.SchemaVersion)
+            if (version < DataMovementBlobConstants.DestinationCheckpointDetails.MinValidSchemaVersion
+                || version > DataMovementBlobConstants.DestinationCheckpointDetails.MaxValidSchemaVersion)
             {
                 throw Errors.UnsupportedJobSchemaVersionHeader(version);
             }
@@ -340,9 +341,17 @@ internal static BlobDestinationCheckpointDetails Deserialize(Stream stream)
             int cacheControlLength = reader.ReadInt32();
 
             // AccessTier
-            bool isAccessTierSet = reader.ReadBoolean();
+            bool isAccessTierSet = default;
+            if (version >= DataMovementBlobConstants.DestinationCheckpointDetails.SchemaVersion_4)
+            {
+                isAccessTierSet = reader.ReadBoolean();
+            }
             AccessTier? accessTier = default;
             JobPlanAccessTier jobPlanAccessTier = (JobPlanAccessTier)reader.ReadByte();
+            if (version < DataMovementBlobConstants.DestinationCheckpointDetails.SchemaVersion_4)
+            {
+                isAccessTierSet = !jobPlanAccessTier.Equals(JobPlanAccessTier.None);
+            }
             if (isAccessTierSet)
             {
                 accessTier = new AccessTier(jobPlanAccessTier.ToString());

sdk/storage/Azure.Storage.DataMovement.Blobs/src/DataMovementBlobConstants.cs

@@ -28,6 +28,8 @@ internal class DestinationCheckpointDetails
             internal const int SchemaVersion_3 = 3;
             internal const int SchemaVersion_4 = 4;
             internal const int SchemaVersion = SchemaVersion_4;
+            internal const int MinValidSchemaVersion = SchemaVersion_3;
+            internal const int MaxValidSchemaVersion = SchemaVersion;
 
             internal const int VersionIndex = 0;
             internal const int PreserveBlobTypeIndex = VersionIndex + IntSizeInBytes;

sdk/storage/Azure.Storage.DataMovement.Blobs/tests/BlobDestinationCheckpointDetailsTests.cs

@@ -233,7 +233,6 @@ public void Deserialize()
             }
         }
 
-        [Ignore("Renable after implementing backwards compatibility for older versions")]
         [Test]
         public void Deserialize_File_Version_3()
         {
@@ -260,7 +259,7 @@ public void Deserialize_File_Version_4()
 
         private void VerifySampleValues_Version3(BlobDestinationCheckpointDetails data)
         {
-            Assert.AreEqual(3, data.Version);
+            Assert.AreEqual(4, data.Version);
             Assert.IsTrue(data.IsBlobTypeSet);
             Assert.AreEqual(DefaultBlobType, data.BlobType);
             Assert.AreEqual(true, data.IsContentTypeSet);
@@ -305,9 +304,11 @@ private void VerifySampleValues_Version4(BlobDestinationCheckpointDetails data)
         }
 
         [Test]
-        public void Deserialize_IncorrectSchemaVersion()
+        [TestCase(1)]
+        [TestCase(2)]
+        [TestCase(5)]
+        public void Deserialize_IncorrectSchemaVersion(int incorrectSchemaVersion)
         {
-            int incorrectSchemaVersion = 1;
             BlobDestinationCheckpointDetails data = CreatePreserveValues();
             data.Version = incorrectSchemaVersion;
 
@@ -318,5 +319,36 @@ public void Deserialize_IncorrectSchemaVersion()
                 () => BlobDestinationCheckpointDetails.Deserialize(dataStream),
                 new ArgumentException($"The checkpoint file schema version {incorrectSchemaVersion} is not supported by this version of the SDK."));
         }
+
+        [Test]
+        public void RoundTrip_Version_4()
+        {
+            BlobDestinationCheckpointDetails original = CreateSetSampleValues();
+            using MemoryStream serialized = new();
+            original.Serialize(serialized);
+            serialized.Position = 0;
+            BlobDestinationCheckpointDetails deserialized = BlobDestinationCheckpointDetails.Deserialize(serialized);
+
+            Assert.AreEqual(DataMovementBlobConstants.DestinationCheckpointDetails.SchemaVersion, deserialized.Version);
+            Assert.AreEqual(original.Version, deserialized.Version);
+            Assert.AreEqual(original.IsBlobTypeSet, deserialized.IsBlobTypeSet);
+            Assert.AreEqual(original.BlobType, deserialized.BlobType);
+            Assert.AreEqual(original.IsContentTypeSet, deserialized.IsContentTypeSet);
+            Assert.AreEqual(original.ContentTypeBytes, deserialized.ContentTypeBytes);
+            Assert.AreEqual(original.IsContentEncodingSet, deserialized.IsContentEncodingSet);
+            Assert.AreEqual(original.ContentEncodingBytes, deserialized.ContentEncodingBytes);
+            Assert.AreEqual(original.IsContentLanguageSet, deserialized.IsContentLanguageSet);
+            Assert.AreEqual(original.ContentLanguageBytes, deserialized.ContentLanguageBytes);
+            Assert.AreEqual(original.IsContentDispositionSet, deserialized.IsContentDispositionSet);
+            Assert.AreEqual(original.ContentDispositionBytes, deserialized.ContentDispositionBytes);
+            Assert.AreEqual(original.IsCacheControlSet, deserialized.IsCacheControlSet);
+            Assert.AreEqual(original.CacheControlBytes, deserialized.CacheControlBytes);
+            Assert.AreEqual(original.IsAccessTierSet, deserialized.IsAccessTierSet);
+            Assert.AreEqual(original.AccessTierValue, deserialized.AccessTierValue);
+            Assert.AreEqual(original.IsMetadataSet, deserialized.IsMetadataSet);
+            Assert.AreEqual(original.Metadata, deserialized.Metadata);
+            Assert.AreEqual(original.PreserveTags, deserialized.PreserveTags);
+            Assert.AreEqual(original.Tags, deserialized.Tags);
+        }
     }
 }