This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-email.git
commit da1b4a95687ccc69793a7248441f72872420dff8 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Wed Dec 13 12:10:00 2023 -0500 Remove dead comments --- .../org/apache/commons/mail/EmailLiveTest.java | 4 -- .../java/org/apache/commons/mail/EmailTest.java | 61 ---------------------- .../org/apache/commons/mail/HtmlEmailTest.java | 32 ------------ .../apache/commons/mail/ImageHtmlEmailTest.java | 3 -- .../apache/commons/mail/InvalidAddressTest.java | 8 --- .../commons/mail/InvalidInternetAddressTest.java | 8 --- .../apache/commons/mail/MultiPartEmailTest.java | 32 ------------ .../commons/mail/SendWithAttachmentsTest.java | 3 -- .../org/apache/commons/mail/SimpleEmailTest.java | 10 ---- 9 files changed, 161 deletions(-) diff --git a/src/test/java/org/apache/commons/mail/EmailLiveTest.java b/src/test/java/org/apache/commons/mail/EmailLiveTest.java index a8fde37..79d902e 100644 --- a/src/test/java/org/apache/commons/mail/EmailLiveTest.java +++ b/src/test/java/org/apache/commons/mail/EmailLiveTest.java @@ -102,10 +102,6 @@ public class EmailLiveTest extends AbstractEmailTest { return email; } - // ====================================================================== - // Start of Tests - // ====================================================================== - /** * A sanity check that a simple email also works in reality. * diff --git a/src/test/java/org/apache/commons/mail/EmailTest.java b/src/test/java/org/apache/commons/mail/EmailTest.java index ed49bb5..312d36f 100644 --- a/src/test/java/org/apache/commons/mail/EmailTest.java +++ b/src/test/java/org/apache/commons/mail/EmailTest.java @@ -160,7 +160,6 @@ public class EmailTest extends AbstractEmailTest { @Test public void testSetContentObject() { - // ==================================================================== // test (string object and valid content type) String testObject = "test string object"; String testContentType = " ; charset=" + EmailConstants.US_ASCII; @@ -169,7 +168,6 @@ public class EmailTest extends AbstractEmailTest { assertEquals(testObject, email.getContentObject()); assertEquals(testContentType, email.getContentType()); - // ==================================================================== // test (null string object and valid content type) testObject = null; testContentType = " ; charset=" + EmailConstants.US_ASCII + " some more here"; @@ -178,7 +176,6 @@ public class EmailTest extends AbstractEmailTest { assertEquals(testObject, email.getContentObject()); assertEquals(testContentType, email.getContentType()); - // ==================================================================== // test (string object and null content type) testObject = "test string object"; testContentType = null; @@ -187,7 +184,6 @@ public class EmailTest extends AbstractEmailTest { assertEquals(testObject, email.getContentObject()); assertEquals(testContentType, email.getContentType()); - // ==================================================================== // test (string object and invalid content type) testObject = "test string object"; testContentType = " something incorrect "; @@ -231,10 +227,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testSetFrom() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com", "m...@home.com")); arrExpected.add(new InternetAddress("joe....@apache.org", "joe....@apache.org")); @@ -252,9 +245,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testSetFromWithEncoding() throws Exception { - // ==================================================================== // Test Success (with charset set) - // ==================================================================== final String testValidEmail = "m...@home.com"; final InternetAddress inetExpected = new InternetAddress("m...@home.com", "m...@home.com", EmailConstants.ISO_8859_1); @@ -269,9 +260,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testSetFrom2() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final String[] testEmailNames = { "Name1", "", null }; final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com", "Name1")); @@ -295,10 +284,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddTo() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com")); arrExpected.add(new InternetAddress("joe....@apache.org")); @@ -315,10 +301,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddToArray() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com")); arrExpected.add(new InternetAddress("joe....@apache.org")); @@ -334,9 +317,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddToWithEncoding() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final String testCharset = EmailConstants.ISO_8859_1; final String[] testEmailNames = { "Name1", "", null }; @@ -357,12 +338,8 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddTo2() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final String[] testEmailNames = { "Name1", "", null }; - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com", "Name1")); arrExpected.add(new InternetAddress("joe....@apache.org")); @@ -385,9 +362,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testSetTo() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final List<InternetAddress> testEmailValid2 = new ArrayList<>(); testEmailValid2.add(new InternetAddress("m...@home.com", "Name1")); testEmailValid2.add(new InternetAddress("joe....@apache.org", "joe....@apache.org")); @@ -412,10 +387,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddCc() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com")); arrExpected.add(new InternetAddress("joe....@apache.org")); @@ -432,10 +404,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddCcArray() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com")); arrExpected.add(new InternetAddress("joe....@apache.org")); @@ -451,9 +420,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddCcWithEncoding() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final String testCharset = EmailConstants.ISO_8859_1; final String[] testEmailNames = { "Name1", "", null }; @@ -474,10 +441,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddCc2() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final String[] testEmailNames = { "Name1", "", null }; final List<InternetAddress> arrExpected = new ArrayList<>(); @@ -502,9 +466,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testSetCc() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final List<InternetAddress> testEmailValid2 = new ArrayList<>(); testEmailValid2.add(new InternetAddress("Name1 <m...@home.com>")); testEmailValid2.add(new InternetAddress("\"joe....@apache.org\" <joe....@apache.org>")); @@ -526,10 +488,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddBcc() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com")); arrExpected.add(new InternetAddress("joe....@apache.org")); @@ -546,10 +505,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddBccArray() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com")); arrExpected.add(new InternetAddress("joe....@apache.org")); @@ -565,9 +521,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddBccWithEncoding() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final String testCharset = EmailConstants.ISO_8859_1; final String[] testEmailNames = { "Name1", "", null }; @@ -588,10 +542,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddBcc2() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final String[] testEmailNames = { "Name1", "", null }; final List<InternetAddress> arrExpected = new ArrayList<>(); @@ -616,9 +567,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testSetBcc() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final List<InternetAddress> testInetEmailValid = new ArrayList<>(); testInetEmailValid.add(new InternetAddress("m...@home.com", "Name1")); testInetEmailValid.add(new InternetAddress("joe....@apache.org", "joe....@apache.org")); @@ -640,10 +589,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddReplyTo() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final List<InternetAddress> arrExpected = new ArrayList<>(); arrExpected.add(new InternetAddress("m...@home.com")); arrExpected.add(new InternetAddress("joe....@apache.org")); @@ -660,9 +606,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddReplyToWithEncoding() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final String testCharset = EmailConstants.ISO_8859_1; final String[] testEmailNames = { "Name1", "", null }; @@ -683,10 +627,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddReplyTo2() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== - final String[] testEmailNames = { "Name1", "", null }; final List<InternetAddress> arrExpected = new ArrayList<>(); @@ -711,9 +652,7 @@ public class EmailTest extends AbstractEmailTest { @Test public void testAddHeader() { - // ==================================================================== // Test Success - // ==================================================================== final Map<String, String> headers = new HashMap<>(); headers.put("X-Priority", "1"); headers.put("Disposition-Notification-To", "m...@home.com"); diff --git a/src/test/java/org/apache/commons/mail/HtmlEmailTest.java b/src/test/java/org/apache/commons/mail/HtmlEmailTest.java index d94876d..db0d461 100644 --- a/src/test/java/org/apache/commons/mail/HtmlEmailTest.java +++ b/src/test/java/org/apache/commons/mail/HtmlEmailTest.java @@ -61,17 +61,12 @@ public class HtmlEmailTest extends AbstractEmailTest { @Test public void testGetSetTextMsg() throws EmailException { - // ==================================================================== // Test Success - // ==================================================================== for (final String validChar : testCharsValid) { this.email.setTextMsg(validChar); assertEquals(validChar, this.email.getTextMsg()); } - - // ==================================================================== // Test Exception - // ==================================================================== for (final String invalidChar : this.testCharsNotValid) { try { this.email.setTextMsg(invalidChar); @@ -85,17 +80,12 @@ public class HtmlEmailTest extends AbstractEmailTest { @Test public void testGetSetHtmlMsg() throws EmailException { - // ==================================================================== // Test Success - // ==================================================================== for (final String validChar : testCharsValid) { this.email.setHtmlMsg(validChar); assertEquals(validChar, this.email.getHtmlMsg()); } - - // ==================================================================== // Test Exception - // ==================================================================== for (final String invalidChar : this.testCharsNotValid) { try { this.email.setHtmlMsg(invalidChar); @@ -109,19 +99,14 @@ public class HtmlEmailTest extends AbstractEmailTest { @Test public void testGetSetMsg() throws EmailException { - // ==================================================================== // Test Success - // ==================================================================== for (final String validChar : testCharsValid) { this.email.setMsg(validChar); assertEquals(validChar, this.email.getTextMsg()); assertTrue(this.email.getHtmlMsg().contains(validChar)); } - - // ==================================================================== // Test Exception - // ==================================================================== for (final String invalidChar : this.testCharsNotValid) { try { this.email.setMsg(invalidChar); @@ -135,9 +120,7 @@ public class HtmlEmailTest extends AbstractEmailTest { @Test public void testEmbedUrl() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final String strEmbed = this.email.embed(new URL(this.strTestURL), "Test name"); assertNotNull(strEmbed); @@ -152,10 +135,7 @@ public class HtmlEmailTest extends AbstractEmailTest { // unique? final String newCid = this.email.embed(new URL(this.strTestURL), "Test name 2"); assertFalse(strEmbed.equals(newCid)); - - // ==================================================================== // Test Exceptions - // ==================================================================== // Does an invalid URL throw an exception? try { @@ -177,9 +157,7 @@ public class HtmlEmailTest extends AbstractEmailTest { @Test public void testEmbedFile() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final File file = File.createTempFile("testEmbedFile", "txt"); file.deleteOnExit(); @@ -255,10 +233,7 @@ public class HtmlEmailTest extends AbstractEmailTest { /** File to used to test file attachments (Must be valid) */ final File testFile = File.createTempFile("commons-email-testfile", ".txt"); testFile.deleteOnExit(); - - // ==================================================================== // Test Success - // ==================================================================== this.getMailServer(); String strSubject = "Test HTML Send #1 Subject (w charset)"; @@ -327,9 +302,7 @@ public class HtmlEmailTest extends AbstractEmailTest { @Test public void testSend2() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== this.getMailServer(); @@ -393,10 +366,7 @@ public class HtmlEmailTest extends AbstractEmailTest { // the mail.mime.charset property is normally cached by the MimeUtility // class, thus setting it to another value while running the tests // might not have the expected result. - - // ==================================================================== // Test Success - // ==================================================================== System.setProperty(EmailConstants.MAIL_MIME_CHARSET, "iso-8859-15"); @@ -540,9 +510,7 @@ public class HtmlEmailTest extends AbstractEmailTest { */ @Test public void testEmbedFileWithCID() throws Exception { - // ==================================================================== // Test Success - // ==================================================================== final File file = File.createTempFile("testEmbedFile", "txt"); file.deleteOnExit(); diff --git a/src/test/java/org/apache/commons/mail/ImageHtmlEmailTest.java b/src/test/java/org/apache/commons/mail/ImageHtmlEmailTest.java index 626fc52..6db26c0 100644 --- a/src/test/java/org/apache/commons/mail/ImageHtmlEmailTest.java +++ b/src/test/java/org/apache/commons/mail/ImageHtmlEmailTest.java @@ -61,10 +61,7 @@ public class ImageHtmlEmailTest extends HtmlEmailTest { // reusable objects to be used across multiple tests email = new MockImageHtmlEmailConcrete(); } - - // ====================================================================== // Start of Tests - // ====================================================================== @Test public void testSendHtml() throws Exception { diff --git a/src/test/java/org/apache/commons/mail/InvalidAddressTest.java b/src/test/java/org/apache/commons/mail/InvalidAddressTest.java index e7e531c..514a09b 100644 --- a/src/test/java/org/apache/commons/mail/InvalidAddressTest.java +++ b/src/test/java/org/apache/commons/mail/InvalidAddressTest.java @@ -51,9 +51,7 @@ public class InvalidAddressTest extends AbstractEmailTest { @Test public void testSetInvalidFrom() throws Exception { - // ==================================================================== // Test setting invalid 'from' addresses - // ==================================================================== for (int i = 0; i < ARR_INVALID_EMAILS.length; i++) { try { // set from @@ -69,9 +67,7 @@ public class InvalidAddressTest extends AbstractEmailTest { @Test public void testAddInvalidTo() throws Exception { - // ==================================================================== // Test adding invalid 'to' addresses - // ==================================================================== for (int i = 0; i < ARR_INVALID_EMAILS.length; i++) { try { // Add To @@ -87,9 +83,7 @@ public class InvalidAddressTest extends AbstractEmailTest { @Test public void testAddInvalidCc() throws Exception { - // ==================================================================== // Test adding invalid 'cc' addresses - // ==================================================================== for (int i = 0; i < ARR_INVALID_EMAILS.length; i++) { try { // add cc @@ -105,9 +99,7 @@ public class InvalidAddressTest extends AbstractEmailTest { @Test public void testAddInvalidBcc() throws Exception { - // ==================================================================== // Test adding invalid 'Bcc' addresses - // ==================================================================== for (int i = 0; i < ARR_INVALID_EMAILS.length; i++) { try { // add bcc diff --git a/src/test/java/org/apache/commons/mail/InvalidInternetAddressTest.java b/src/test/java/org/apache/commons/mail/InvalidInternetAddressTest.java index d931aa2..3a221f2 100644 --- a/src/test/java/org/apache/commons/mail/InvalidInternetAddressTest.java +++ b/src/test/java/org/apache/commons/mail/InvalidInternetAddressTest.java @@ -66,9 +66,7 @@ public class InvalidInternetAddressTest extends AbstractEmailTest { @Test public void testStrictConstructor() throws Exception { - // ==================================================================== // Prove InternetAddress constructor is throwing exception. - // ==================================================================== // test Invalid Email addresses for (int i = 0; i < ARR_INVALID_EMAILS.length; i++) { @@ -101,11 +99,8 @@ public class InvalidInternetAddressTest extends AbstractEmailTest { if (validateMethod == null) { return; } - - // ==================================================================== // Prove InternetAddress constructor isn't throwing exception and // the validate() method is - // ==================================================================== for (int i = 0; i < ARR_INVALID_EMAILS.length; i++) { @@ -141,11 +136,8 @@ public class InvalidInternetAddressTest extends AbstractEmailTest { if (validateMethod == null) { return; } - - // ==================================================================== // Prove InternetAddress constructor isn't throwing exception and // the validate() method is - // ==================================================================== for (int i = 0; i < ARR_INVALID_EMAILS.length; i++) { diff --git a/src/test/java/org/apache/commons/mail/MultiPartEmailTest.java b/src/test/java/org/apache/commons/mail/MultiPartEmailTest.java index 93d3cd0..0b55819 100644 --- a/src/test/java/org/apache/commons/mail/MultiPartEmailTest.java +++ b/src/test/java/org/apache/commons/mail/MultiPartEmailTest.java @@ -62,9 +62,7 @@ public class MultiPartEmailTest extends AbstractEmailTest { @Test public void testSetMsg() throws EmailException { - // ==================================================================== // Test Success - // ==================================================================== // without charset set for (final String validChar : testCharsValid) { @@ -78,10 +76,7 @@ public class MultiPartEmailTest extends AbstractEmailTest { this.email.setMsg(validChar); assertEquals(validChar, this.email.getMsg()); } - - // ==================================================================== // Test Exceptions - // ==================================================================== for (final String invalidChar : testCharsNotValid) { try { this.email.setMsg(invalidChar); @@ -98,9 +93,7 @@ public class MultiPartEmailTest extends AbstractEmailTest { */ @Test public void testSend() throws EmailException, IOException { - // ==================================================================== // Test Success - // ==================================================================== this.getMailServer(); final String strSubject = "Test Multipart Send Subject"; @@ -144,10 +137,7 @@ public class MultiPartEmailTest extends AbstractEmailTest { // validate attachment validateSend(this.fakeMailServer, strSubject, attachment.getName(), testEmail.getFromAddress(), testEmail.getToAddresses(), testEmail.getCcAddresses(), testEmail.getBccAddresses(), false); - - // ==================================================================== // Test Exceptions - // ==================================================================== try { this.getMailServer(); @@ -161,35 +151,23 @@ public class MultiPartEmailTest extends AbstractEmailTest { @Test public void testAttach() throws Exception { EmailAttachment attachment; - - // ==================================================================== // Test Success - EmailAttachment - // ==================================================================== attachment = new EmailAttachment(); attachment.setName("Test Attachment"); attachment.setDescription("Test Attachment Desc"); attachment.setPath(testFile.getAbsolutePath()); this.email.attach(attachment); assertTrue(this.email.isBoolHasAttachments()); - - // ==================================================================== // Test Success - URL - // ==================================================================== attachment = new EmailAttachment(); attachment.setName("Test Attachment"); attachment.setDescription("Test Attachment Desc"); attachment.setURL(new URL(this.strTestURL)); this.email.attach(attachment); - - // ==================================================================== // Test Success - File - // ==================================================================== this.email.attach(testFile); assertTrue(this.email.isBoolHasAttachments()); - - // ==================================================================== // Test Exceptions - // ==================================================================== // null attachment try { this.email.attach((EmailAttachment) null); @@ -225,9 +203,7 @@ public class MultiPartEmailTest extends AbstractEmailTest { */ @Test public void testAttach2() throws MalformedURLException, EmailException { - // ==================================================================== // Test Success - URL - // ==================================================================== this.email.attach(new URL(this.strTestURL), "Test Attachment", "Test Attachment Desc"); // bad name @@ -236,14 +212,9 @@ public class MultiPartEmailTest extends AbstractEmailTest { @Test public void testAttach3() throws Exception { - // ==================================================================== // Test Success - URL - // ==================================================================== this.email.attach(new URLDataSource(new URL(this.strTestURL)), "Test Attachment", "Test Attachment Desc"); - - // ==================================================================== // Test Exceptions - // ==================================================================== // null datasource try { final URLDataSource urlDs = null; @@ -265,11 +236,8 @@ public class MultiPartEmailTest extends AbstractEmailTest { @Test public void testAttachFileLocking() throws Exception { - - // ==================================================================== // EMAIL-120: attaching a FileDataSource may result in a locked file // resource on windows systems - // ==================================================================== final File tmpFile = File.createTempFile("attachment", ".eml"); diff --git a/src/test/java/org/apache/commons/mail/SendWithAttachmentsTest.java b/src/test/java/org/apache/commons/mail/SendWithAttachmentsTest.java index 7bcd27f..0efe4ac 100644 --- a/src/test/java/org/apache/commons/mail/SendWithAttachmentsTest.java +++ b/src/test/java/org/apache/commons/mail/SendWithAttachmentsTest.java @@ -92,10 +92,7 @@ public class SendWithAttachmentsTest extends AbstractEmailTest { /** File to used to test file attachments (Must be valid) */ final File testFile = File.createTempFile("commons-email-testfile", ".txt"); - - // ==================================================================== // Test Success - // ==================================================================== this.getMailServer(); final String strSubject = "Test HTML Send #1 Subject (w charset)"; diff --git a/src/test/java/org/apache/commons/mail/SimpleEmailTest.java b/src/test/java/org/apache/commons/mail/SimpleEmailTest.java index a4d5649..782e412 100644 --- a/src/test/java/org/apache/commons/mail/SimpleEmailTest.java +++ b/src/test/java/org/apache/commons/mail/SimpleEmailTest.java @@ -43,17 +43,12 @@ public class SimpleEmailTest extends AbstractEmailTest { @Test public void testGetSetMsg() throws EmailException { - // ==================================================================== // Test Success - // ==================================================================== for (final String validChar : testCharsValid) { this.email.setMsg(validChar); assertEquals(validChar, this.email.getMsg()); } - - // ==================================================================== // Test Exception - // ==================================================================== for (final String invalidChar : this.testCharsNotValid) { try { this.email.setMsg(invalidChar); @@ -71,9 +66,7 @@ public class SimpleEmailTest extends AbstractEmailTest { */ @Test public void testSend() throws EmailException, IOException { - // ==================================================================== // Test Success - // ==================================================================== this.getMailServer(); this.email = new MockSimpleEmail(); @@ -109,10 +102,7 @@ public class SimpleEmailTest extends AbstractEmailTest { * not defined, reverts to the default Java charset which is basically the system default file encoding. */ System.setProperty(EmailConstants.MAIL_MIME_CHARSET, "utf-8"); - - // ==================================================================== // Test Success - // ==================================================================== this.getMailServer(); this.email = new MockSimpleEmail();