differentiate between text body and html body

stho32 · stho32 · commit d26b90d8e250 · 2022-02-03T20:00:33.000+01:00
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Actions/MoveEmailToFolderActionFactoryTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Actions/MoveEmailToFolderActionFactoryTests.cs
@@ -1,4 +1,6 @@
+using MailKit;
 using spamfilter.BL.Actions;
+using spamfilter.BL.Entities;
 using Xunit;
 
 namespace spamfilter.BL.Tests.Actions;
@@ -9,7 +11,7 @@ public class MoveEmailToFolderActionFactoryTests
     public void Instanciates_a_class_of_type_MoveEmailToFolderAction()
     {
         var factory = new MoveEmailToFolderActionFactory("targetfolder");
-        var action = factory.CreateFromEmail(null);
+        var action = factory.CreateFromEmail(new Email("", "", UniqueId.Invalid, "", "", ""));
         Assert.IsType<MoveEmailToFolderAction>(action); 
     }
 }
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Actions/MoveEmailToFolderActionTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Actions/MoveEmailToFolderActionTests.cs
@@ -1,4 +1,5 @@
 using spamfilter.BL.Actions;
+using spamfilter.BL.Entities;
 using spamfilter.BL.Tests.Mocks;
 using Xunit;
 
@@ -10,7 +11,9 @@ public class MoveEmailToFolderActionTests
     public void Execute_calls_the_MoveEmailToFolder_method_of_the_emailrepository()
     {
         var emailrepository = new EmailRepositoryMock();
-        var action = new MoveEmailToFolderAction(null, "SomeFolder");
+        var action = new MoveEmailToFolderAction(
+            Email.Empty(), 
+            "SomeFolder");
         action.Execute(emailrepository);
         
         Assert.True(emailrepository.MoveMailsToFolderHasBeenCalled);
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Detectors/BelowSizeDetectorTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Detectors/BelowSizeDetectorTests.cs
@@ -22,7 +22,8 @@ public void When_an_email_is_below_a_specified_size_it_is_detected()
             "",
             UniqueId.Invalid,
             "This is a subject",
-            "This body has a size below 1000 bytes."
+            "This body has a size below 1000 bytes.",
+            ""
         );
 
         var detector = BelowSizeDetector(1000);
@@ -38,7 +39,8 @@ public void When_an_email_is_bigger_than_a_specified_size_it_is_not_detected()
             "",
             UniqueId.Invalid,
             "This is a subject",
-            "This body is bigger than 20 bytes."
+            "This body is bigger than 20 bytes.",
+            ""
         );
 
         var detector = BelowSizeDetector(20);
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Detectors/ContentBasedDetectorTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Detectors/ContentBasedDetectorTests.cs
@@ -27,6 +27,7 @@ public void When_Hello_is_in_the_subject_and_we_search_for_it_it_detects()
             "",
             UniqueId.Invalid,
             "Hello",
+            "",
             ""
         );
 
@@ -43,6 +44,7 @@ public void When_Hello_is_not_in_the_subject_and_we_search_for_it_it_does_not_de
             "",
             UniqueId.Invalid,
             "------",
+            "",
             ""
         );
 
@@ -59,7 +61,8 @@ public void When_hello_is_in_the_body_but_we_search_in_the_subject_it_is_not_det
             "",
             UniqueId.Invalid,
             "Here is some other text",
-            "Hello"
+            "Hello",
+            ""
         );
 
         var detector = Detector(true, false);
@@ -75,7 +78,8 @@ public void When_hello_is_in_the_subject_but_we_search_in_the_body_it_is_not_det
             "",
             UniqueId.Invalid,
             "Hello",
-            "Some other text"
+            "Some other text",
+            ""
         );
 
         var detector = Detector(false, true);
@@ -91,7 +95,8 @@ public void When_hello_is_in_the_body_and_we_search_in_the_body_it_is_detected()
             "",
             UniqueId.Invalid,
             "Some other Text",
-            "Hello"
+            "Hello",
+            ""
         );
 
         var detector = Detector(false, true);
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Detectors/DetectionResultTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Detectors/DetectionResultTests.cs
@@ -18,7 +18,8 @@ public void ConstructionTest()
                 "",
                 UniqueId.Invalid,
                 "Subject",
-                "Body"),
+                "Body",
+                ""),
             Array.Empty<IIsMatchOpinion>());
         
         Assert.Equal("Hello world", detectionResult.Email.SenderName);
@@ -35,7 +36,8 @@ public void When_multiple_opinions_are_there_the_one_with_the_highest_priority_i
                 "",
                 UniqueId.Invalid,
                 "Subject",
-                "Body"),
+                "Body",
+                ""),
             new IIsMatchOpinion[]
             {
                 new IsMatchOpinion(10, "I am uncertain", "Someone", true),
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Detectors/DetectorGroupTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Detectors/DetectorGroupTests.cs
@@ -25,8 +25,8 @@ public void For_every_email_there_is_a_detection_result_based_on_the_detectors()
         var results = detectorGroup.Filter(
             new IEmail[]
             {
-                new Email("Sender", "Sender", UniqueId.Invalid, "Subject", "Body"),
-                new Email("Sender", "Sender", UniqueId.Invalid, "Subject", "Body")
+                new Email("Sender", "Sender", UniqueId.Invalid, "Subject", "Body", ""),
+                new Email("Sender", "Sender", UniqueId.Invalid, "Subject", "Body", "")
             });
         
         Assert.Equal(2, results.Length);
@@ -46,8 +46,8 @@ public void When_an_exception_occurs_in_a_detector_we_detect_nothing()
         var results = detectorGroup.Filter(
             new IEmail[]
             {
-                new Email("Sender", "Sender", UniqueId.Invalid, "Subject", "Body"),
-                new Email("Sender", "Sender", UniqueId.Invalid, "Subject", "Body")
+                new Email("Sender", "Sender", UniqueId.Invalid, "Subject", "Body", ""),
+                new Email("Sender", "Sender", UniqueId.Invalid, "Subject", "Body", "")
             });
         
         Assert.Empty(results);
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Detectors/DomainExpressionBasedDetectorTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Detectors/DomainExpressionBasedDetectorTests.cs
@@ -22,6 +22,7 @@ public void When_the_domain_is_matching_the_regular_expression_it_detects()
             "brian@amazon.de",
             UniqueId.Invalid,
             "",
+            "",
             ""
         );
 
@@ -38,6 +39,7 @@ public void When_the_domain_is_not_matching_the_regular_expression_it_does_not_d
             "brian@amazon.de",
             UniqueId.Invalid,
             "",
+            "",
             ""
         );
 
@@ -55,6 +57,7 @@ public void
             "brian@amazon.de",
             UniqueId.Invalid,
             "",
+            "",
             ""
         );
 
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Detectors/EmailEndsWithBasedDetectorTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Detectors/EmailEndsWithBasedDetectorTests.cs
@@ -22,6 +22,7 @@ public void When_the_email_address_ends_with_the_string_then_it_detects()
             "brian@amazon.de",
             UniqueId.Invalid,
             "",
+            "",
             ""
         );
 
@@ -38,6 +39,7 @@ public void When_the_email_address_does_not_end_with_the_string_it_does_not_dete
             "brian@amazon.de",
             UniqueId.Invalid,
             "",
+            "",
             ""
         );
 
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Detectors/ImpersonatorSpamDetectorTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Detectors/ImpersonatorSpamDetectorTests.cs
@@ -28,7 +28,8 @@ public void A_mail_from_amazon_is_ok_if_it_is_from_amazon_de()
             "amazon@amazon.de",
             UniqueId.Invalid,
             "Your orders",
-            "Some stuff");
+            "Some stuff",
+            "");
         
         Assert.Empty(SpamDetector().GetOpinionsOn(mail));
     }
@@ -41,7 +42,8 @@ public void A_mail_from_amazon_is_ok_if_it_is_from_amazon_com()
             "amazon@amazon.com",
             UniqueId.Invalid,
             "Your orders",
-            "Some stuff");
+            "Some stuff", 
+            "");
         
         Assert.Empty(SpamDetector().GetOpinionsOn(mail));
     }
@@ -54,7 +56,8 @@ public void A_mail_from_amazon_is_NOT_ok_if_domain_is_wrong()
             "amazon@someimpersonator.com",
             UniqueId.Invalid, 
             "Your orders",
-            "some stuff");
+            "some stuff",
+            "");
 
         var result = SpamDetector().GetOpinionsOn(mail);
         Assert.Single(result);
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Detectors/InvalidSenderEmailAddressSpamDetectorTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Detectors/InvalidSenderEmailAddressSpamDetectorTests.cs
@@ -26,6 +26,7 @@ public void When_the_attached_emailvalidator_is_satisfied_we_get_OK()
             "amazon@amazon.de",
             UniqueId.Invalid,
             "Your orders",
+            "",
             "");
         
         Assert.Empty(SpamDetector().GetOpinionsOn(mail));
@@ -39,6 +40,7 @@ public void When_the_attached_emailvalidator_is_not_satisfied_it_is_spam()
             "Not-an-email",
             UniqueId.Invalid,
             "Your orders",
+            "",
             "");
         
         Assert.NotEmpty(SpamDetector().GetOpinionsOn(mail));
diff --git a/Source/spamfilter/spamfilter.BL.Tests/ExtensionMethods/ActionArrayExecuteTests.cs b/Source/spamfilter/spamfilter.BL.Tests/ExtensionMethods/ActionArrayExecuteTests.cs
@@ -1,3 +1,4 @@
+using spamfilter.BL.Entities;
 using spamfilter.BL.Tests.Rules;
 using spamfilter.Interfaces;
 using spamfilter.BL.ExtensionMethods;
@@ -14,8 +15,8 @@ public void Execute_does_execute_every_action_in_the_array()
     {
         var actions = new IAction[]
         {
-            new ActionMock(null),
-            new ActionMock(null)
+            new ActionMock(Email.Empty()),
+            new ActionMock(Email.Empty())
         };
 
         actions.Execute(new EmailRepositoryMock());
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Rules/ExampleRuleFactoryTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Rules/ExampleRuleFactoryTests.cs
@@ -1,4 +1,6 @@
+using spamfilter.BL.Environment;
 using spamfilter.BL.Rules;
+using spamfilter.BL.Tests.Mocks;
 using Xunit;
 
 namespace spamfilter.BL.Tests.Rules;
@@ -8,7 +10,10 @@ public class ExampleRuleFactoryTests
     [Fact]
     public void Construction_does_not_throw_an_exception()
     {
-        var factory = new ExampleRuleFactory(null, null);
+        var factory = new ExampleRuleFactory(
+            new EmailRepositoryMock(), 
+            EnvironmentFactory.NoEnvironment());
+        
         var rule = factory.Create();
         Assert.True(true);
     }
diff --git a/Source/spamfilter/spamfilter.BL.Tests/Rules/RuleTests.cs b/Source/spamfilter/spamfilter.BL.Tests/Rules/RuleTests.cs
@@ -28,8 +28,8 @@ public void For_every_matching_email_it_returns_an_action()
         var actions = rule.Execute(
             new IEmail[]
             {
-                new Email("", "", UniqueId.Invalid, "1" , ""),
-                new Email("", "", UniqueId.Invalid, "2" , "")
+                new Email("", "", UniqueId.Invalid, "1" , "", ""),
+                new Email("", "", UniqueId.Invalid, "2" , "", "")
             }
         );
         
diff --git a/Source/spamfilter/spamfilter.BL/Detectors/BelowSizeDetector.cs b/Source/spamfilter/spamfilter.BL/Detectors/BelowSizeDetector.cs
@@ -16,7 +16,7 @@ public BelowSizeDetector(int detectBodySizeBelowNBytes)
     
     public IIsMatchOpinion[] GetOpinionsOn(IEmail email)
     {
-        if (email.Body.Length < _detectBodySizeBelowNBytes)
+        if (email.TextBody.Length < _detectBodySizeBelowNBytes)
         {
             return new IIsMatchOpinion[]
             {
diff --git a/Source/spamfilter/spamfilter.BL/Detectors/ContentBasedDetector.cs b/Source/spamfilter/spamfilter.BL/Detectors/ContentBasedDetector.cs
@@ -41,7 +41,7 @@ public IIsMatchOpinion[] GetOpinionsOn(IEmail email)
 
         if (_checkBody)
         {
-            if (_textSearchHelper.ContainsOneOfTheseWords(email.Body, _words))
+            if (_textSearchHelper.ContainsOneOfTheseWords(email.TextBody, _words))
             {
                 result.Add(
                     new IsMatchOpinion(100,
diff --git a/Source/spamfilter/spamfilter.BL/Entities/Email.cs b/Source/spamfilter/spamfilter.BL/Entities/Email.cs
@@ -1,5 +1,4 @@
 using MailKit;
-using spamfilter.Interfaces;
 using spamfilter.Interfaces.Entities;
 
 namespace spamfilter.BL.Entities;
@@ -10,19 +9,33 @@ public class Email : IEmail
     public string SenderEmailaddress { get; }
     public UniqueId Id { get; }
     public string Subject { get; }
-    public string Body { get; }
+    public string TextBody { get; }
+    public string HtmlBody { get; }
 
-    public Email(string senderName, string senderEmailaddress, UniqueId id, string subject, string body)
+    public Email(string senderName, string senderEmailaddress, UniqueId id, string subject, string body, string htmlBody)
     {
         SenderName = senderName;
         SenderEmailaddress = senderEmailaddress;
         Id = id;
         Subject = subject;
-        Body = body;
+        TextBody = body;
+        HtmlBody = htmlBody;
     }
 
     public override string ToString()
     {
         return $"{nameof(SenderName)}: {SenderName}, {nameof(SenderEmailaddress)}: {SenderEmailaddress}, {nameof(Id)}: {Id}, {nameof(Subject)}: {Subject}";
     }
+
+    public static IEmail Empty()
+    {
+        return new Email(
+            "", 
+            "", 
+            UniqueId.Invalid, 
+            "", 
+            "", 
+            ""
+        );
+    }
 }
diff --git a/Source/spamfilter/spamfilter.Infrastructure/Repositories/ImapEmailRepository.cs b/Source/spamfilter/spamfilter.Infrastructure/Repositories/ImapEmailRepository.cs
@@ -99,7 +99,8 @@ public IEmail[] GetInboxContent()
                     senderAddress,
                     uniqueId,
                     message.Subject,
-                    message.TextBody));
+                    message.TextBody,
+                    message.HtmlBody));
             }
 
             client.Disconnect(true);
diff --git a/Source/spamfilter/spamfilter.Interfaces/Entities/IEmail.cs b/Source/spamfilter/spamfilter.Interfaces/Entities/IEmail.cs
@@ -12,5 +12,6 @@ public interface IEmail
     
     UniqueId Id { get; }
     string Subject { get; }
-    string Body { get; }
+    string TextBody { get; }
+    string HtmlBody { get; }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
	`1`	`+using MailKit;`
`1`	`2`	`using spamfilter.BL.Actions;`
	`3`	`+using spamfilter.BL.Entities;`
`2`	`4`	`using Xunit;`
`3`	`5`
`4`	`6`	`namespace spamfilter.BL.Tests.Actions;`
`@@ -9,7 +11,7 @@ public class MoveEmailToFolderActionFactoryTests`
`9`	`11`	`public void Instanciates_a_class_of_type_MoveEmailToFolderAction()`
`10`	`12`	`{`
`11`	`13`	`var factory = new MoveEmailToFolderActionFactory("targetfolder");`
`12`		`- var action = factory.CreateFromEmail(null);`
	`14`	`+ var action = factory.CreateFromEmail(new Email("", "", UniqueId.Invalid, "", "", ""));`
`13`	`15`	`Assert.IsType<MoveEmailToFolderAction>(action);`
`14`	`16`	`}`
`15`	`17`	`}`