Revize 414636c0

commentary

new comments for testing classes and messages for failed tests

Backend/BackendTesting/UserManagementTesting.cs

@@ -17 +17 @@
 
 namespace Core.Services
 {
+    //class responsible for testing user and backend autentication on login
     [TestClass]
     public class UserManagementTesting      //testing of Core/Services/UserService
     {
+        //necessary items for new database with my data for teting
         private static readonly IConfiguration configuration = new ConfigurationBuilder().Build();
         public DatabaseContext ctx;
-
         public Core.Services.IUserService US;
+        
+        //constructor for creating database and filling it with dummy data
         public UserManagementTesting()
         {
+            //creating new database
             this.ctx = new DatabaseContext(configuration);
             this.US = new UserServiceEF(this.ctx, TestingLogger.GetLogger(), TestingMapper.GetMapper());
 
+            //ensure the database is fresh without unwanted users from previous testings
             ctx.Database.EnsureDeleted();
             ctx.Database.EnsureCreated();
 
-            //vytvoření dat pro testování
+            //data for testing creation
             var userList = new List<User>();
             userList.Add(new User() { Username = "aaa", Name = "aaa", Surname = "aaa", Password = "aaa", Role = Models.Enums.ERole.ANNOTATOR });
             userList.Add(new User() { Username = "bbb", Name = "bbb", Surname = "bbb", Password = "bbb", Role = Models.Enums.ERole.ANNOTATOR });
@@ -45 +50 @@
             userList.Add(new User() { Username = "iii", Name = "iii", Surname = "iii", Password = "iii", Role = Models.Enums.ERole.ADMINISTRATOR });
             userList.Add(new User() { Username = "jjj", Name = "jjj", Surname = "jjj", Password = "jjj", Role = Models.Enums.ERole.ADMINISTRATOR });
 
-            //nahrani do databaze
+            //filling up the database
             foreach (var user in userList)
             {
                 US.CreateUser(user.Username, user.Name, user.Surname, user.Password, user.Role);
@@ -98 +103 @@
             {
                 if (user.Username == username)
                 {
-                    //checking, that user with wanted username was not changed
-                    /*Assert.AreEqual(expected.Username, user.Username);*/
-                    Assert.AreEqual(name, user.Name);
-                    Assert.AreEqual(surname, user.Surname);
-                    Assert.AreNotEqual(password, user.Password);
-                    Assert.AreEqual(role, user.Role);
+                    //checking, that user with wanted username was not changed and he is present in database
+                    //if there were some data changed (not username) - these tests will fail
+                    Assert.AreEqual(name, user.Name, "names are not same");
+                    Assert.AreEqual(surname, user.Surname, "surnames are not same");
+                    Assert.AreNotEqual(password, user.Password, "passwords are same - it should have been hashed");
+                    Assert.AreEqual(role, user.Role, "roles are not same");
                     return;
                 }
             }
-            //if there was username not found, inserted user must have been changed or wasnt saved into database at all - test fails
+            //if there was username not found, inserted users username must have been changed or wasnt saved into database at all - test fails
             Assert.Fail("supposedly created user was not found in database");
         }
 
@@ -115 +120 @@
         [DataRow("aaa", "aaa", "aaa", "aaa", "aaa", ERole.ANNOTATOR)]
         [DataRow("bbb", "bbb", "bbb", "bbb", "bbb", ERole.ANNOTATOR)]
         [DataRow("ccc", "ccc", "ccc", "ccc", "ccc", ERole.ADMINISTRATOR)]
-        //method testing, that user searched by username is the one wanted - data are inserted before
+        //method testing, that user searched by username is the one wanted - data are inserted in constructor
         public void GetUserByUsername_Test(string insertedUsername, string username, string name, string surname, string password, ERole role)
         {
             User? actual = US.GetUserByUsername(insertedUsername);
@@ -130 +135 @@
         [DataRow("aaa", "aaa", "aaa", "aaa", ERole.ANNOTATOR)]
         [DataRow("bbb", "bbb", "bbb", "bbb", ERole.ANNOTATOR)]
         [DataRow("ccc", "ccc", "ccc", "ccc", ERole.ADMINISTRATOR)]
+        //testing method to get user via his ID, using another tested method - GetUserByUsername
         public void GetUserById_Test(string username, string name, string surname, string password, ERole role)
         {
-            //TODO Find id other way then via another tested method
             User? expected = US.GetUserByUsername(username);
             if (expected == null)
             {
-                Assert.Fail();
+                Assert.Fail("There is mistake in test data or in GetUserByUsername method");
                 return;
             }
-
             User? actual = US.GetUserById(expected.Id);
 
             //testing whole users
-            Assert.AreEqual(expected, actual);
+            Assert.AreEqual(expected, actual, "Users are not same");
 
             //testing all parameters
-            Assert.AreEqual(actual.Username, username);
-            Assert.AreEqual(actual.Name, name);
-            Assert.AreEqual(actual.Surname, surname);
-            Assert.AreNotEqual(actual.Password, password);
-            Assert.AreEqual(actual.Role, role);
+            Assert.AreEqual(actual.Username, username, "usernames are not same");
+            Assert.AreEqual(actual.Name, name, "names are not same");
+            Assert.AreEqual(actual.Surname, surname, "surnames are not same");
+            Assert.AreNotEqual(actual.Password, password, "passwords ARE same (the one from database should have been hashed)");
+            Assert.AreEqual(actual.Role, role, "roles are not same");
         }
 
 
@@ -164 +168 @@
         [DataRow("xxx", "xxx", "xxx", "xxx", ERole.ANNOTATOR, "xxx", "bbb", "ccc", ERole.ANNOTATOR)]
         [DataRow("xxx", "xxx", "xxx", "xxx", ERole.ANNOTATOR, "xxx", "xxx", "xxx", ERole.ADMINISTRATOR)]
         [DataRow("xxx", "xxx", "xxx", "xxx", ERole.ANNOTATOR, "xxx", "bbb", "ccc", ERole.ADMINISTRATOR)]
+        //creating new user and updating him
         public void UpdateUser_Test(string oldUsername, string oldName, string oldSurname, string password, ERole oldRole, string? username = null, string? name = null, string? surname = null, ERole? role = null)
         {
+            //new user creation
             User? newUser = US.CreateUser(oldUsername, oldName, oldSurname, password, oldRole);
             if(newUser == null)
             {
-                Assert.Fail("user not created");
+                Assert.Fail("user not created (maybe already user username?)");
             }
             User? actual = US.UpdateUser(newUser, username, name, surname, role);
 
-            Assert.IsNotNull(actual);
+            Assert.IsNotNull(actual, "user wasnt updated, null was returned");
             Assert.AreEqual(username, actual.Username, "wrong username");
             Assert.AreEqual(name, actual.Name, "wrong name");
             Assert.AreEqual(surname, actual.Surname, "wrong surname");
@@ -186 +192 @@
         [DataRow("ccc", "aaa")]//admin
         [DataRow("bbb", "")]//set to none password
         [DataRow("eee", "eee")]//keep old password
+        //test of changing password
         public void ChangePassword_Test(string username, string newPassword) 
         {
-            //get user
+            //get user using GetUserByUsername
             User? changingUser = US.GetUserByUsername(username);
             if(changingUser == null)
             {
@@ -229 +236 @@
         [DataRow("aaa", "aaa")]//anotator
         [DataRow("fff", "fff")]//anotator
         [DataRow("iii", "iii")]//admin
+        //testing login autentication CheckUsernamePassword
         public void CheckUsernamePassword_Correct(string username, string password)
         {
             User? checkedUser = US.CheckUsernamePassword(username, password);
@@ -244 +252 @@
                 Assert.Fail("There is mistake in tested data");
                 return;
             }
-            Assert.AreEqual(expected, checkedUser);
+            Assert.AreEqual(expected, checkedUser, "Users are not same (maybe wrong password)");
         }
 
+
         [TestMethod]
         [DataRow("aaa", "bbb")]//changedPassword?
         [DataRow("fff", "fgh")]//anotator
@@ -256 +265 @@
             User? checkedUser = US.CheckUsernamePassword(username, password);
             if (checkedUser != null)
             {
-                //there are just correct users - this should have returned user
+                //there are just incorrect users - this should not have returned user
                 Assert.Fail("there are just incorrect users-passwords - this should not return user");
                 return;
             }
@@ -265 +274 @@
         [TestMethod]
         [DataRow("fff", "fff", "123")]//anotator
         [DataRow("iii", "iii", "456")]//admin
+        //more complex test of the same as the above
+        //passwords are changed and then there is login
         public void CheckUsernamePassword_ChangedPassword(string username, string oldPassword, string newPassword)
         {
             //get user from database
             User? oldUser = US.CheckUsernamePassword(username, oldPassword);
             if (oldUser == null) 
             {
-                Assert.Fail("This should have returned user - there are wrong input data");
+                Assert.Fail("This should have returned user - there are wrong input data or CheckUsernamePassword isnt working properly");
                 return;
             }
             //change users password
@@ -301 +312 @@
             }
         }
         [TestMethod]
+        //I dont really know how to test this
         public void GetUsers_Test()
         {
             var userList = US.GetUsers();
@@ -310 +322 @@
 
 
         [TestMethod]
-        //correct
+        //login from AuthService testing with correct username-password
         [DataRow("aaa", "aaa", ERole.ANNOTATOR)]//anotator
         [DataRow("fff", "fff", ERole.ANNOTATOR)]//anotator
         [DataRow("iii", "iii", ERole.ADMINISTRATOR)]//admin
         public void AuthService_Login_Correct(string username, string password, ERole role)
         {
+            //creating new instance of AuthService
             var jwt = TestingJwtUtils.GetJwtUtils();
             var AS = new AuthService(US, jwt);
-         //   var AS = new AuthServiceEF(this.ctx, TestingLogger.GetLogger(), TestingMapper.GetMapper());
+            //try login
             var loginResults = AS.Login(username, password);
+            //check results
             Assert.IsNotNull(loginResults);
             Assert.IsTrue(loginResults.Ok);
             Assert.IsNotNull(loginResults.Token);
             DateTime exp = loginResults.Expiration;
+            //expiration is in the future
             var now = new DateTime(DateTime.Now.Year, DateTime.Now.Month, DateTime.Now.Day, DateTime.Now.Hour, DateTime.Now.Minute, DateTime.Now.Second);
             Assert.IsTrue(exp.CompareTo(now) > 0);//if compare is >0 -> exp is in the future
             Assert.AreEqual(role, loginResults.Role);
         }
 
-        //incorrect
+        //login from AuthService testing with incorrect username-password
         [TestMethod]
         [DataRow("aaa", "bbb")]//changedPassword?
         [DataRow("fff", "fgh")]//anotator
         [DataRow("iii", "123")]//admin
         public void AuthService_Login_Incorrect(string username, string password)
         {
+            //creating new instance of AuthService
             var jwt = TestingJwtUtils.GetJwtUtils();
             var AS = new AuthService(US, jwt);
-            //   var AS = new AuthServiceEF(this.ctx, TestingLogger.GetLogger(), TestingMapper.GetMapper());
             var loginResults = AS.Login(username, password);
+            //checking if login results are null or there is false in OK and there is none obtained token
             if (loginResults != null)
             {
                 Assert.IsFalse(loginResults.Ok);