feat(AgDb): AddUser (#100)

* feat(AgDb): AddUser

* feat(tests): AddUser

* fix(format): user constructor

* fix(null): _user field

* fix(review): param and return type

* fix(review): explicit create, code reuse, remove unecessary methods

* fix(review): perm in Database

* fix(review): format

* feat(Add/DropUser): IAgDb

Author: mja9

src/AgDatabase.cs

@@ -39,6 +39,8 @@ void Restore(IEnumerable<BackupMetadata> backupOrder, Func<int, TimeSpan> retryD
     IEnumerable<LoginProperties> AssociatedLogins();
     void DropLogin(LoginProperties login);
     void DropAllLogins();
+    void AddUser(UserProperties user);
+    void DropUser(UserProperties user);
     void AddRole(LoginProperties login, RoleProperties role);
     IEnumerable<RoleProperties> AssociatedRoles();
     void ContainsLogin(string loginName);
@@ -200,6 +202,16 @@ private void AddNewSqlLogin(LoginProperties login)
       Parallel.ForEach(_listener.Secondaries, server => server.AddLogin(login));
     }
 
+    public void AddUser(UserProperties user)
+    {
+      _listener.Primary.Database(Name).AddUser(user);
+    }
+
+    public void DropUser(UserProperties user)
+    {
+      _listener.Primary.Database(Name)?.DropUser(user);
+    }
+
     public IEnumerable<RoleProperties> AssociatedRoles()
     {
       return _listener.Primary.Roles.Select(r => r.Properties());

src/SmoFacade/Database.cs

@@ -44,12 +44,46 @@ public void DropAssociatedLogins()
     {
       var logins = Users.Where(u => u.Login != null && u.Login.Name != "sa")
         .Select(u => u.Login.Properties());
-      foreach(var login in logins)
-        _server.DropLogin(new LoginProperties {
+      foreach (var login in logins)
+        _server.DropLogin(new LoginProperties
+        {
           Name = login.Name
         });
     }
 
+    public User AddUser(UserProperties userProperties)
+    {
+      var user = Users.SingleOrDefault(u => u.Name.Equals(userProperties.Name, StringComparison.InvariantCultureIgnoreCase));
+      if (user == null)
+      {
+        var smoUser = new Microsoft.SqlServer.Management.Smo.User(_database, userProperties.Name)
+        { Login = userProperties.LoginName };
+        smoUser.Create();
+        user = new User(smoUser, _server);
+
+        foreach (var role in userProperties.Roles)
+        {
+          user.AddRole(role);
+        }
+
+        GrantPermission(userProperties);
+      }
+
+      return user;
+    }
+
+    private void GrantPermission(UserProperties userProperties)
+    {
+      _database.Grant(userProperties.Permissions, userProperties.Name);
+    }
+
+    public void DropUser(UserProperties userProperties)
+    {
+      var matchingUser =
+        Users.SingleOrDefault(u => u.Name.Equals(userProperties.Name, StringComparison.InvariantCultureIgnoreCase));
+      matchingUser?.Drop();
+    }
+
     /// <summary>
     ///   Kills connections and deletes the database.
     /// </summary>
@@ -61,7 +95,8 @@ public void Drop()
         .Handle<FailedOperationException>()
         .WaitAndRetry(3, retryAttempt => TimeSpan.FromMilliseconds(Math.Pow(10, retryAttempt)));
 
-      policy.Execute(() => {
+      policy.Execute(() =>
+      {
         _database.Refresh();
         _database.Parent.KillDatabase(_database.Name);
       });
@@ -97,8 +132,9 @@ public List<BackupMetadata> MostRecentBackupChain()
       cmd.Parameters.Add(dbName);
 
       using var reader = cmd.ExecuteReader();
-      while(reader.Read())
-        backups.Add(new BackupMetadata {
+      while (reader.Read())
+        backups.Add(new BackupMetadata
+        {
           CheckpointLsn = (decimal)reader["checkpoint_lsn"],
           DatabaseBackupLsn = (decimal)reader["database_backup_lsn"],
           DatabaseName = (string)reader["database_name"],
@@ -129,7 +165,7 @@ public decimal MostRecentFullBackupLsn()
       cmd.Parameters.Add(dbName);
 
       using var reader = cmd.ExecuteReader();
-      if(!reader.Read())
+      if (!reader.Read())
         throw new Exception("MostRecentFullBackup SQL found no results");
 
       var lsnValue = reader["most_recent_full_backup_checkpoint_lsn"];
@@ -166,8 +202,9 @@ public List<BackupMetadata> BackupChainFromLsn(decimal checkpointLsn)
       cmd.Parameters.Add(lsnParam);
 
       using var reader = cmd.ExecuteReader();
-      while(reader.Read())
-        backups.Add(new BackupMetadata {
+      while (reader.Read())
+        backups.Add(new BackupMetadata
+        {
           CheckpointLsn = (decimal)reader["checkpoint_lsn"],
           DatabaseBackupLsn = (decimal)reader["database_backup_lsn"],
           DatabaseName = (string)reader["database_name"],
@@ -210,23 +247,26 @@ private void ThrowIfUnreadyToDrop()
         .WaitAndRetry(6, retryAttempt => TimeSpan.FromMilliseconds(Math.Pow(5, retryAttempt)));
 
       // ensure database is not in AvailabilityGroup, WaitAndRetry loop for each instance to sync
-      policyPrep.Execute(() => {
+      policyPrep.Execute(() =>
+      {
         _database.Refresh();
-        if(Restoring)
+        if (Restoring)
           return; // restoring state means we're good to drop
 
-        try {
-          if(!string.IsNullOrEmpty(_database.AvailabilityGroupName))
+        try
+        {
+          if (!string.IsNullOrEmpty(_database.AvailabilityGroupName))
             throw
               new Exception($"Cannot kill the database {Name} until it has been removed from the AvailabilityGroup");
-          if(_database.AvailabilityDatabaseSynchronizationState >
+          if (_database.AvailabilityDatabaseSynchronizationState >
              AvailabilityDatabaseSynchronizationState.NotSynchronizing)
             throw new
               Exception($"Cannot kill the database {Name} until AvailabilityDatabaseSynchronizationState is inaccessible");
         }
-        catch(
-          PropertyCannotBeRetrievedException) { } // good here, AvailabilityDatabaseSynchronizationState unavailable means it has no state
-        catch(SmoException e) when(e.Message.Contains("Cannot access properties or methods")) { }
+        catch (
+          PropertyCannotBeRetrievedException)
+        { } // good here, AvailabilityDatabaseSynchronizationState unavailable means it has no state
+        catch (SmoException e) when (e.Message.Contains("Cannot access properties or methods")) { }
       });
     }
   }

src/SmoFacade/User.cs

@@ -1,18 +1,39 @@
 namespace AgDatabaseMove.SmoFacade
 {
+  using System.Collections.Generic;
+  using Smo = Microsoft.SqlServer.Management.Smo;
+
+  public class UserProperties
+  {
+    public string Name { get; set; }
+    public IEnumerable<RoleProperties> Roles { get; set; }
+    public Smo.DatabasePermissionSet Permissions { get; set; }
+    public string LoginName { get; set; }
+  }
+
   public class User
   {
     private readonly Server _server;
-    private readonly Microsoft.SqlServer.Management.Smo.User _user;
+    private readonly Smo.User _user;
 
-    public User(Microsoft.SqlServer.Management.Smo.User user, Server server)
+    public User(Smo.User user, Server server)
     {
       _user = user;
       _server = server;
     }
 
     public string Name => _user.Name;
 
+    public void AddRole(RoleProperties role)
+    {
+      _user.AddToRole(role.Name);
+    }
+
+    public void Drop()
+    {
+      _user.Drop();
+    }
+
     public Login Login
     {
       get

tests/AgDatabaseMove.Integration/Fixtures/TestAgDatabaseFixture.cs

@@ -28,6 +28,7 @@ public TestAgDatabaseFixture()
         DatabaseName = _agConfig.DatabaseName,
         CredentialName = _agConfig.CredentialName
       });
+
       _agDatabase.AddLogin(new LoginProperties
       {
         Name = _loginConfig.LoginName,
@@ -36,6 +37,14 @@ public TestAgDatabaseFixture()
         DefaultDatabase = _loginConfig.DefaultDatabase
       });
 
+      _agDatabase.AddUser(new UserProperties
+      {
+        Name = _loginConfig.LoginName,
+        LoginName = _loginConfig.LoginName,
+        Roles = new[] { new RoleProperties { Name = "db_datareader" } },
+        Permissions = new DatabasePermissionSet(DatabasePermission.Execute)
+      });
+
       _createdLogins = GetCreatedLogins();
     }
 
@@ -56,6 +65,7 @@ public TestAgDatabaseFixture()
     public void Dispose()
     {
       _agDatabase?.DropLogin(new LoginProperties { Name = _loginConfig.LoginName });
+      _agDatabase?.DropUser(new UserProperties { Name = _loginConfig.LoginName });
       _agDatabase?.Dispose();
     }
   }

tests/AgDatabaseMove.Integration/TestAgDatabase.cs

@@ -25,5 +25,28 @@ public void TestLoginSidsMatch()
       var sid = _fixture._createdLogins.First().Sid;
       Assert.All(_fixture._createdLogins.Select(l => l.Sid), s => Assert.Equal(s, sid));
     }
+
+    [Fact]
+    public void TestUserExists()
+    {
+      var db = _fixture._agDatabase._listener.Primary.Database(_fixture._agConfig.DatabaseName);
+      Assert.Contains(_fixture._loginConfig.LoginName, db.Users.Select(u => u.Name));
+    }
+
+    [Fact]
+    public void TestUserHasRoles()
+    {
+      var db = _fixture._agDatabase._listener.Primary.Database(_fixture._agConfig.DatabaseName)._database;
+      var user = db.Users[_fixture._loginConfig.LoginName];
+      Assert.True(user.EnumRoles().Contains("db_datareader"));
+    }
+
+    [Fact]
+    public void TestUserHasPermissions()
+    {
+      var db = _fixture._agDatabase._listener.Primary.Database(_fixture._loginConfig.DefaultDatabase)._database;
+      var permissions = db.EnumDatabasePermissions(_fixture._loginConfig.LoginName);
+      Assert.NotNull(permissions.FirstOrDefault(p => p.PermissionType.Execute));
+    }
   }
 }