Introduce PackageRegistrationAuditRecord

NuGet · Jun 17, 2016 · d1d291b · d1d291b
1 parent 3b5f924
commit d1d291b
Show file tree

Hide file tree

Showing 8 changed files with 105 additions and 54 deletions.
diff --git a/src/NuGetGallery.Core/Auditing/PackageAuditAction.cs b/src/NuGetGallery.Core/Auditing/PackageAuditAction.cs
@@ -10,8 +10,6 @@ public enum PackageAuditAction
         Created,
         Listed,
         Unlisted,
-        AddOwner,
-        RemoveOwner,
         Edit,
         UndoEdit
     }

diff --git a/src/NuGetGallery.Core/Auditing/PackageAuditRecord.cs b/src/NuGetGallery.Core/Auditing/PackageAuditRecord.cs
@@ -1,11 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
-using System;
-using System.Collections.Generic;
-using System.ComponentModel;
 using System.Data;
-using System.Globalization;
 
 namespace NuGetGallery.Auditing
 {
@@ -34,58 +30,21 @@ public PackageAuditRecord(string id, string version, string hash, DataTable pack
         public PackageAuditRecord(Package package, PackageAuditAction action, string reason)
             : this(package.PackageRegistration.Id, package.Version, package.Hash, null, null, action, reason)
         {
-            PackageRecord = ConvertToDataTable(package);
-            RegistrationRecord = ConvertToDataTable(package.PackageRegistration);
+            PackageRecord = DataTableUtility.ConvertToDataTable(package);
+            RegistrationRecord = DataTableUtility.ConvertToDataTable(package.PackageRegistration);
         }
 
         public PackageAuditRecord(Package package, PackageAuditAction action)
             : this(package.PackageRegistration.Id, package.Version, package.Hash, null, null, action, null)
         {
-            PackageRecord = ConvertToDataTable(package);
-            RegistrationRecord = ConvertToDataTable(package.PackageRegistration);
+            PackageRecord = DataTableUtility.ConvertToDataTable(package);
+            RegistrationRecord = DataTableUtility.ConvertToDataTable(package.PackageRegistration);
         }
-
-        public PackageAuditRecord(PackageRegistration packageRegistration, PackageAuditAction action, string reason)
-            : this(packageRegistration.Id, "0.0", null, null, null, action, reason)
-        {
-            RegistrationRecord = ConvertToDataTable(packageRegistration);
-        }
-
+
         public override string GetPath()
         {
             return $"{Id}/{NuGetVersionNormalizer.Normalize(Version)}"
                 .ToLowerInvariant();
         }
-
-        private static DataTable ConvertToDataTable<T>(T instance)
-        {
-            PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(typeof(T));
-            DataTable table = new DataTable() { Locale = CultureInfo.CurrentCulture };
-
-            List<object> values = new List<object>();
-            for (int i = 0; i < properties.Count; i++)
-            {
-                var propertyDescriptor = properties[i];
-                var propertyType = Nullable.GetUnderlyingType(propertyDescriptor.PropertyType) ?? propertyDescriptor.PropertyType;
-                if (!IsComplexType(propertyType))
-                {
-                    table.Columns.Add(propertyDescriptor.Name, propertyType);
-                    values.Add(propertyDescriptor.GetValue(instance) ?? DBNull.Value);
-                }
-            }
-
-            table.Rows.Add(values.ToArray());
-
-            return table;
-        }
-
-        private static bool IsComplexType(Type type)
-        {
-            if (type.IsSubclassOf(typeof(ValueType)) || type == typeof(string))
-            {
-                return false;
-            }
-            return true;
-        }
     }
 }
diff --git a/src/NuGetGallery.Core/Auditing/PackageRegistrationAuditAction.cs b/src/NuGetGallery.Core/Auditing/PackageRegistrationAuditAction.cs
@@ -0,0 +1,11 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+namespace NuGetGallery.Auditing
+{
+    public enum PackageRegistrationAuditAction
+    {
+        AddOwner,
+        RemoveOwner
+    }
+}
diff --git a/src/NuGetGallery.Core/Auditing/PackageRegistrationAuditRecord.cs b/src/NuGetGallery.Core/Auditing/PackageRegistrationAuditRecord.cs
@@ -0,0 +1,33 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System.Data;
+
+namespace NuGetGallery.Auditing
+{
+    public class PackageRegistrationAuditRecord : AuditRecord<PackageRegistrationAuditAction>
+    {
+        public string Id { get; set; }
+        public DataTable RegistrationRecord { get; set; }
+
+        public string Reason { get; set; }
+
+        public PackageRegistrationAuditRecord(string id,  DataTable registrationRecord, PackageRegistrationAuditAction action, string reason)
+            : base(action)
+        {
+            Id = id;
+            RegistrationRecord = registrationRecord;
+            Reason = reason;
+        }
+
+        public PackageRegistrationAuditRecord(PackageRegistration packageRegistration, PackageRegistrationAuditAction action, string reason)
+            : this(packageRegistration.Id, DataTableUtility.ConvertToDataTable(packageRegistration), action, reason)
+        {
+        }
+
+        public override string GetPath()
+        {
+            return $"{Id}".ToLowerInvariant();
+        }
+    }
+}
diff --git a/src/NuGetGallery.Core/DataTableUtility.cs b/src/NuGetGallery.Core/DataTableUtility.cs
@@ -0,0 +1,45 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Data;
+using System.Globalization;
+
+namespace NuGetGallery
+{
+    public static class DataTableUtility
+    {
+        public static DataTable ConvertToDataTable<T>(T instance)
+        {
+            PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(typeof(T));
+            DataTable table = new DataTable() { Locale = CultureInfo.CurrentCulture };
+
+            List<object> values = new List<object>();
+            for (int i = 0; i < properties.Count; i++)
+            {
+                var propertyDescriptor = properties[i];
+                var propertyType = Nullable.GetUnderlyingType(propertyDescriptor.PropertyType) ?? propertyDescriptor.PropertyType;
+                if (!IsComplexType(propertyType))
+                {
+                    table.Columns.Add(propertyDescriptor.Name, propertyType);
+                    values.Add(propertyDescriptor.GetValue(instance) ?? DBNull.Value);
+                }
+            }
+
+            table.Rows.Add(values.ToArray());
+
+            return table;
+        }
+
+        private static bool IsComplexType(Type type)
+        {
+            if (type.IsSubclassOf(typeof(ValueType)) || type == typeof(string))
+            {
+                return false;
+            }
+            return true;
+        }
+    }
+}
diff --git a/src/NuGetGallery.Core/NuGetGallery.Core.csproj b/src/NuGetGallery.Core/NuGetGallery.Core.csproj
@@ -144,11 +144,14 @@
     <Compile Include="Auditing\CredentialAuditRecord.cs" />
     <Compile Include="Auditing\PackageAuditAction.cs" />
     <Compile Include="Auditing\PackageAuditRecord.cs" />
+    <Compile Include="Auditing\PackageRegistrationAuditAction.cs" />
+    <Compile Include="Auditing\PackageRegistrationAuditRecord.cs" />
     <Compile Include="Auditing\UserAuditAction.cs" />
     <Compile Include="Auditing\UserAuditRecord.cs" />
     <Compile Include="CoreConstants.cs" />
     <Compile Include="CredentialTypes.cs" />
     <Compile Include="Completion.cs" />
+    <Compile Include="DataTableUtility.cs" />
     <Compile Include="DisposableAction.cs" />
     <Compile Include="Entities\Credential.cs" />
     <Compile Include="Entities\CuratedFeed.cs" />

diff --git a/src/NuGetGallery/Services/PackageService.cs b/src/NuGetGallery/Services/PackageService.cs
@@ -249,7 +249,8 @@ public async Task AddPackageOwnerAsync(PackageRegistration package, User user)
                 await _packageOwnerRequestRepository.CommitChangesAsync();
             }
 
-            await _auditingService.SaveAuditRecord(new PackageAuditRecord(package, PackageAuditAction.AddOwner, $"Added owner: {user.Username}"));
+            await _auditingService.SaveAuditRecord(
+                new PackageRegistrationAuditRecord(package, PackageRegistrationAuditAction.AddOwner, $"Added owner: {user.Username}"));
         }
 
         public async Task RemovePackageOwnerAsync(PackageRegistration package, User user)
@@ -270,7 +271,8 @@ public async Task RemovePackageOwnerAsync(PackageRegistration package, User user
             package.Owners.Remove(user);
             await _packageRepository.CommitChangesAsync();
 
-            await _auditingService.SaveAuditRecord(new PackageAuditRecord(package, PackageAuditAction.RemoveOwner, $"Removed owner: {user.Username}"));
+            await _auditingService.SaveAuditRecord(
+                new PackageRegistrationAuditRecord(package, PackageRegistrationAuditAction.RemoveOwner, $"Removed owner: {user.Username}"));
         }
 
         public async Task MarkPackageListedAsync(Package package, bool commitChanges = true)

diff --git a/tests/NuGetGallery.Facts/Services/PackageServiceFacts.cs b/tests/NuGetGallery.Facts/Services/PackageServiceFacts.cs
@@ -180,8 +180,8 @@ public async Task WritesAnAuditRecord()
                 await service.AddPackageOwnerAsync(package, pendingOwner);
 
                 // Assert
-                Assert.True(auditingService.WroteRecord<PackageAuditRecord>(ar =>
-                    ar.Action == PackageAuditAction.AddOwner
+                Assert.True(auditingService.WroteRecord<PackageRegistrationAuditRecord>(ar =>
+                    ar.Action == PackageRegistrationAuditAction.AddOwner
                     && ar.Id == package.Id));
             }
         }
@@ -1907,8 +1907,8 @@ public async Task WritesAnAuditRecord()
                 await service.RemovePackageOwnerAsync(package, ownerToRemove);
 
                 // Assert
-                Assert.True(auditingService.WroteRecord<PackageAuditRecord>(ar =>
-                    ar.Action == PackageAuditAction.RemoveOwner
+                Assert.True(auditingService.WroteRecord<PackageRegistrationAuditRecord>(ar =>
+                    ar.Action == PackageRegistrationAuditAction.RemoveOwner
                     && ar.Id == package.Id));
             }
         }