[Asterisk-code-review] Unit tests: Fix more unit test description strings. (asterisk[master])

Joshua Colp asteriskteam at digium.com
Thu Jun 25 04:50:54 CDT 2015


Joshua Colp has submitted this change and it was merged.

Change subject: Unit tests: Fix more unit test description strings.
......................................................................


Unit tests: Fix more unit test description strings.

Analyzing the code shows that the unit test summary and description
strings should not end with a new-line character.  Where these strings are
used in the code a new-line is provided for output.

Change-Id: I2f4f37988ec363c8d1c5077a2fc8ca841c5cd30c
---
M res/res_sorcery_memory_cache.c
M tests/test_dns_naptr.c
M tests/test_dns_srv.c
M tests/test_sorcery_memory_cache_thrash.c
4 files changed, 29 insertions(+), 29 deletions(-)

Approvals:
  Matt Jordan: Looks good to me, but someone else must approve
  Joshua Colp: Looks good to me, approved; Verified



diff --git a/res/res_sorcery_memory_cache.c b/res/res_sorcery_memory_cache.c
index dae7606..7a07d14 100644
--- a/res/res_sorcery_memory_cache.c
+++ b/res/res_sorcery_memory_cache.c
@@ -1604,7 +1604,7 @@
 			"\t* Creates a memory cache with default configuration\n"
 			"\t* Creates a memory cache with a maximum object count of 10 and verifies it\n"
 			"\t* Creates a memory cache with a maximum object lifetime of 60 and verifies it\n"
-			"\t* Creates a memory cache with a stale object lifetime of 90 and verifies it\n";
+			"\t* Creates a memory cache with a stale object lifetime of 90 and verifies it";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -1675,7 +1675,7 @@
 			"\t* Create a memory cache with a maximum object lifetime of -1\n"
 			"\t* Create a memory cache with a maximum object lifetime of toast\n"
 			"\t* Create a memory cache with a stale object lifetime of -1\n"
-			"\t* Create a memory cache with a stale object lifetime of toast\n";
+			"\t* Create a memory cache with a stale object lifetime of toast";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -1758,7 +1758,7 @@
 			"\t* Creates a sorcery instance with a test object\n"
 			"\t* Creates a test object with an id of test\n"
 			"\t* Pushes the test object into the memory cache\n"
-			"\t* Confirms that the test object is in the cache\n";
+			"\t* Confirms that the test object is in the cache";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -1840,7 +1840,7 @@
 			"\t* Confirms that the test object is in the cache\n"
 			"\t* Creates a new test object with the same id of test\n"
 			"\t* Pushes the new test object into the memory cache\n"
-			"\t* Confirms that the new test object has replaced the old one\n";
+			"\t* Confirms that the new test object has replaced the old one";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -1932,7 +1932,7 @@
 			"\t* Pushes the test object into the memory cache\n"
 			"\t* Confirms that the test object is in the cache\n"
 			"\t* Deletes the test object from the cache\n"
-			"\t* Confirms that the test object is no longer in the cache\n";
+			"\t* Confirms that the test object is no longer in the cache";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -2056,7 +2056,7 @@
 			"\t* Deletes charlie from the memory cache\n"
 			"\t* Confirms that only bob is in the memory cache\n"
 			"\t* Pushes alice into the memory cache\n"
-			"\t* Confirms that bob and alice are in the memory cache\n";
+			"\t* Confirms that bob and alice are in the memory cache";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -2171,7 +2171,7 @@
 			"\t* Creates a memory cache with a maximum object lifetime of 5 seconds\n"
 			"\t* Pushes 10 objects into the memory cache\n"
 			"\t* Waits (up to) 10 seconds for expiration to occur\n"
-			"\t* Confirms that the objects have been removed from the cache\n";
+			"\t* Confirms that the objects have been removed from the cache";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -2386,7 +2386,7 @@
 			"\t\t* Retrieve the stale cached object\n"
 			"\t\t* Ensure that the stale object retrieved is the same as the fresh one from earlier\n"
 			"\t\t* Wait for the cache to update with new data\n"
-			"\t\t* Ensure that new data in the cache matches backend data\n";
+			"\t\t* Ensure that new data in the cache matches backend data";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
diff --git a/tests/test_dns_naptr.c b/tests/test_dns_naptr.c
index c7c7eb3..96c745d 100644
--- a/tests/test_dns_naptr.c
+++ b/tests/test_dns_naptr.c
@@ -197,7 +197,7 @@
 		info->description = "This test defines four valid NAPTR records and\n"
 			"performs a resolution of the domain to which they belong. The test\n"
 			"ensures that all fields of the NAPTR records are parsed correctly\n"
-			"and that the records are returned in sorted order\n";
+			"and that the records are returned in sorted order";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -334,7 +334,7 @@
 		info->description = "This test defines a set of records where the strings provided\n"
 			"within the record are valid, but the lengths of the strings in the record are\n"
 			"invalid, either too large or too small. The goal of this test is to ensure that\n"
-			"these invalid lengths result in resolution failures\n";
+			"these invalid lengths result in resolution failures";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -374,7 +374,7 @@
 		info->description = "This test defines a set of records where the flags provided are\n"
 			"invalid in some way. This may be due to providing non-alphanumeric characters or\n"
 			"by providing clashing flags. The result should be that none of the defined records\n"
-			"are returned by the resolver\n";
+			"are returned by the resolver";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -405,7 +405,7 @@
 		info->description = "This test defines a set of records where the services provided are\n"
 			"invalid in some way. This may be due to providing non-alphanumeric characters, providing\n"
 			"protocols or resolution services that start with a non-alphabetic character, or\n"
-			"providing fields that are too long.\n";
+			"providing fields that are too long.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -440,7 +440,7 @@
 		info->summary = "Ensure that NAPTR records with invalid regexps are not presented in results";
 		info->description = "This test defines a set of records where the regexps provided are\n"
 			"invalid in some way. The test ensures that none of the invalid records are returned\n"
-			"when performing a NAPTR lookup\n";
+			"when performing a NAPTR lookup";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -466,7 +466,7 @@
 		info->category = "/main/dns/naptr/";
 		info->summary = "Ensure that NAPTR records with invalid interactions are not presented in results";
 		info->description = "This test defines a set of records where all parts are individually valid,\n"
-			"but when combined do not make sense and are thus invalid.\n";
+			"but when combined do not make sense and are thus invalid.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
diff --git a/tests/test_dns_srv.c b/tests/test_dns_srv.c
index c5145bb..2e89dab 100644
--- a/tests/test_dns_srv.c
+++ b/tests/test_dns_srv.c
@@ -200,7 +200,7 @@
 		info->summary = "Test an SRV lookup which returns a single record";
 		info->description = "This test defines a single SRV record and performs a\n"
 			"resolution of the domain to which they belong. The test ensures that all\n"
-			"fields of the SRV record are parsed correctly\n";
+			"fields of the SRV record are parsed correctly";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -225,7 +225,7 @@
 		info->description = "This test defines two SRV records with differing priorities and\n"
 			"performs a resolution of the domain to which they belong. The test ensures that\n"
 			"the two records are sorted according to priority and that all fields of the SRV\n"
-			"records are parsed correctly\n";
+			"records are parsed correctly";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -250,7 +250,7 @@
 		info->description = "This test defines two SRV records with same priority but different weights and\n"
 			"performs a resolution of the domain to which they belong. The test ensures that\n"
 			"the record with zero weight comes last and that all fields of the SRV\n"
-			"records are parsed correctly\n";
+			"records are parsed correctly";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -277,7 +277,7 @@
 		info->summary = "Test an SRV lookup which returns two records with same priority but different weights";
 		info->description = "This test defines two SRV records with same priority but different weights and\n"
 			"performs a resolution of the domain to which they belong. The test ensures that\n"
-			"the record with higher weight occurs more often than the one of lesser weight\n";
+			"the record with higher weight occurs more often than the one of lesser weight";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -367,7 +367,7 @@
 		info->description = "This test defines four SRV records, two with one priority and two with another priority,\n"
 			"and different weights and performs a resolution of the domain to which they belong.\n"
 			"The test ensures that the priorities are sorted properly and that the records with higher weight\n"
-			"occur more often than the ones of less weight.\n";
+			"occur more often than the ones of less weight.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -504,7 +504,7 @@
 		info->summary = "Test an SRV lookup which returns a single invalid record";
 		info->description = "This test defines a single SRV record and performs a\n"
 			"resolution of the domain to which they belong. The test ensures that the\n"
-			"record is determined to be corrupt as it contains only a priority\n";
+			"record is determined to be corrupt as it contains only a priority";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -526,7 +526,7 @@
 		info->summary = "Test an SRV lookup which returns a single invalid record";
 		info->description = "This test defines a single SRV record and performs a\n"
 			"resolution of the domain to which they belong. The test ensures that the\n"
-			"record is determined to be corrupt as it contains only a priority and weight\n";
+			"record is determined to be corrupt as it contains only a priority and weight";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -549,7 +549,7 @@
 		info->description = "This test defines a single SRV record and performs a\n"
 			"resolution of the domain to which they belong. The test ensures that the\n"
 			"record is determined to be corrupt as it contains only a priority, weight,\n"
-			"and port\n";
+			"and port";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
diff --git a/tests/test_sorcery_memory_cache_thrash.c b/tests/test_sorcery_memory_cache_thrash.c
index 89ce829..daf5234 100644
--- a/tests/test_sorcery_memory_cache_thrash.c
+++ b/tests/test_sorcery_memory_cache_thrash.c
@@ -464,7 +464,7 @@
 			"after 1 second. It also creates 25 threads which are constantly attempting\n"
 			"to retrieve the objects. This test confirms that the background refreshes\n"
 			"being done as a result of going stale do not conflict or cause problems with\n"
-			"the large number of retrieve threads.\n";
+			"the large number of retrieve threads.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -483,7 +483,7 @@
 		info->description = "This test creates a cache with objects that are expired\n"
 			"after 1 second. It also creates 25 threads which are constantly attempting\n"
 			"to retrieve the objects. This test confirms that the expiration process does\n"
-			"not cause a problem as the retrieve threads execute.\n";
+			"not cause a problem as the retrieve threads execute.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -502,7 +502,7 @@
 		info->description = "This test creates a cache with objects that are being constantly\n"
 			"updated and retrieved at the same time. This will create contention between all\n"
 			"of the threads as the write lock is held for the updates. This test confirms that\n"
-			"no problems occur in this situation.\n";
+			"no problems occur in this situation.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -522,7 +522,7 @@
 			"allowed in it. The maximum number of unique objects, however, far exceeds the\n"
 			"the maximum number allowed in the cache. This test confirms that the cache does\n"
 			"not exceed the maximum and that the removal of older objects does not cause\n"
-			"a problem.\n";
+			"a problem.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -542,7 +542,7 @@
 			"allowed in it with objects that also go stale after a period of time and expire.\n"
 			"A number of threads are created that constantly retrieve from the cache, causing\n"
 			"both stale refresh and expiration to occur. This test confirms that the combination\n"
-			"of these do not present a problem.\n";
+			"of these do not present a problem.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -561,7 +561,7 @@
 		info->summary = "Thrash a cache with a large number of objects that expire and go stale";
 		info->description = "This test creates a cache with a large number of objects that expire\n"
 			"and go stale. As there is such a large number this ensures that both operations occur.\n"
-			"This test confirms that stale refreshing and expiration do not conflict.\n";
+			"This test confirms that stale refreshing and expiration do not conflict.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;
@@ -580,7 +580,7 @@
 		info->summary = "Thrash a cache with a large number of objects";
 		info->description = "This test creates a cache with a large number of objects that persist.\n"
 			"A large number of threads are created which constantly retrieve from the cache.\n"
-			"This test confirms that the large number of retrieves do not cause a problem.\n";
+			"This test confirms that the large number of retrieves do not cause a problem.";
 		return AST_TEST_NOT_RUN;
 	case TEST_EXECUTE:
 		break;

-- 
To view, visit https://gerrit.asterisk.org/718
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I2f4f37988ec363c8d1c5077a2fc8ca841c5cd30c
Gerrit-PatchSet: 1
Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Owner: Richard Mudgett <rmudgett at digium.com>
Gerrit-Reviewer: Joshua Colp <jcolp at digium.com>
Gerrit-Reviewer: Matt Jordan <mjordan at digium.com>



More information about the asterisk-code-review mailing list