// xestiaab_common.h - Xestia Address Book Common Functions Unit Tests.
//
-// (c) 2012-2015 Xestia Software Development.
+// (c) 2012-2017 Xestia Software Development.
//
// This file is part of Xestia Address Book.
//
static wxString AccountInput2 = "Example2";
static wxString AccountInput3 = "Example3";
-TEST(CommonFunctions, GivenAPredefinedPathWhenGetUserDirIsCalledThenReceivedPathMatches){
+TEST(CommonFunctions, GivenAPredefinedPathWhenGetUserDirIsCalledThenReceivedPathMatches)
+{
// Run the unit tests depending on the operating system being used.
}
-TEST(CommonFunctions, GivenAPredefinedPathWhenGetUserPrefDirIsCalledThenReceivedPathMatches){
+TEST(CommonFunctions, GivenAPredefinedPathWhenGetUserPrefDirIsCalledThenReceivedPathMatches)
+{
// Run the unit tests depending on the operating system being used.
}
-TEST(CommonFunctions, GivenThreePredefinedPathsWhenGetAccountDirIsCalledForEachThenReceivedPathsMatches){
+TEST(CommonFunctions, GivenThreePredefinedPathsWhenGetAccountDirIsCalledForEachThenReceivedPathsMatches)
+{
// Run the unit tests depending on the operating system being used.
}
-TEST(CommonFunctions, GivenThreePredefinedFilePathsWhenGetAccountDirIsCalledWithAppendServerCertificateSetToTrueForEachThenReceivedPathsMatches){
+TEST(CommonFunctions, GivenThreePredefinedFilePathsWhenGetAccountDirIsCalledWithAppendServerCertificateSetToTrueForEachThenReceivedPathsMatches)
+{
// Run the unit tests depending on the operating system being used.
}
-TEST(CommonFunctions, GivenPredefinedFilePathWhenGetAccountsFileIsCalledThenReceivedFilePathMatches){
+TEST(CommonFunctions, GivenPredefinedFilePathWhenGetAccountsFileIsCalledThenReceivedFilePathMatches)
+{
// Run the unit tests depending on the operating system being used.
}
-TEST(CommonFunctions, GivenPredefinedFilePathWhenGetSettingsFileIsCalledThenReceivedFilePathMatches){
+TEST(CommonFunctions, GivenPredefinedFilePathWhenGetSettingsFileIsCalledThenReceivedFilePathMatches)
+{
// Run the unit tests depending on the operating system being used.
}
-TEST(CommonFunctions, GivenFivePredefinedFilenamePathsWhenCreateFilenamePathIsCalledThenReceivedPathMatches){
+TEST(CommonFunctions, GivenFivePredefinedFilenamePathsWhenCreateFilenamePathIsCalledThenReceivedPathMatches)
+{
// Run the unit tests depending on the operating system being used.
}
-TEST(CommonFunctions, GivenTwoFilesWhenGetMIMEIsCalledThenBothFilesMIMETypesAreGiven){
+TEST(CommonFunctions, GivenTwoFilesWhenGetMIMEIsCalledThenBothFilesMIMETypesAreGiven)
+{
// Get the MIME type based on the files given.
}
-TEST(CommonFunctions, GivenTwoDomainNamesWhenCheckBlacklistIsCalledThenReturnsCorrectStatus){
+TEST(CommonFunctions, GivenTwoDomainNamesWhenCheckBlacklistIsCalledThenReturnsCorrectStatus)
+{
// Test that the blacklist is actually working.
}
-TEST(CommonFunctions, EscapeString){
+TEST(CommonFunctions, GivenExampleStringWhenEscapeStringIsCalledThenReturnedStringIsExample)
+{
// Test the escape string function.
+ // Given
+
wxString EscapeStringData = "Example";
+
+ // When
+
EscapeString(&EscapeStringData, false);
+
+ // Then
+
ASSERT_EQ("Example", EscapeStringData.ToStdString());
+
+}
+
+TEST(CommonFunctions, GivenStringWithCommaWhenEscapeStringIsCalledThenCommaIsEscaped)
+{
- EscapeStringData = "Here we go, an \"example\" of escaping string.";
+ // Test the escape string function.
+
+ // Given
+
+ wxString EscapeStringData = "Here we go, an \"example\" of escaping string.";
+
+ // When
+
EscapeString(&EscapeStringData, false);
+
+ // Then
+
ASSERT_EQ("Here we go\\, an \"example\" of escaping string.", EscapeStringData.ToStdString());
- EscapeStringData = "Lets put some \nnew \nlines \nin \nhere.";
+}
+
+TEST(CommonFunctions, GivenStringWithNewlineCharactersWhenEscapeStringIsCalledThenNewlinesAreEscaped)
+{
+
+ // Test the escape string function.
+
+ // Given
+
+ wxString EscapeStringData = "Lets put some \nnew \nlines \nin \nhere.";
+
+ // When
+
EscapeString(&EscapeStringData, false);
+
+ // Then
+
ASSERT_EQ("Lets put some \\nnew \\nlines \\nin \\nhere.", EscapeStringData.ToStdString());
- EscapeStringData = "Lets put some \r\nnew \r\nlines \r\nin \r\nhere.";
+}
+
+TEST(CommonFunctions, GivenAStringWithReturnCharactersWhenEscapeStringIsCalledThenReturnsAreRemoved)
+{
+
+ // Test the escape string function.
+
+ // Given
+
+ wxString EscapeStringData = "Lets put some \r\nnew \r\nlines \r\nin \r\nhere.";
+
+ // When
+
EscapeString(&EscapeStringData, false);
+
+ // Then
+
ASSERT_EQ("Lets put some \\nnew \\nlines \\nin \\nhere.", EscapeStringData.ToStdString());
- EscapeStringData = "A:\\path\\example\\lets\\have\\some\\fun";
+}
+
+TEST(CommonFunctions, GivenStringWithBackslashesWhenEscapeStringIsCalledThenBackslashesAreEscaped)
+{
+
+ // Test the escape string function.
+
+ // Given
+
+ wxString EscapeStringData = "A:\\path\\example\\lets\\have\\some\\fun";
+
+ // When
+
EscapeString(&EscapeStringData, false);
+
+ // Then
+
ASSERT_EQ("A:\\\\path\\\\example\\\\lets\\\\have\\\\some\\\\fun", EscapeStringData.ToStdString());
}
-TEST(CommonFunctions, CaptureString){
+TEST(CommonFunctions, GivenExampleStringWhenCaptureStringIsCalledThenReturnedStringIsExample)
+{
// Test the capture string function.
+ // Given
+
wxString CaptureStringData = "Example";
+
+ // When
+
CaptureString(&CaptureStringData, false);
+
+ // Then
+
ASSERT_EQ("Example", CaptureStringData.ToStdString());
- CaptureStringData = "Here we go\\, an \"example\" of escaping string.";
+}
+
+TEST(CommonFunctions, GivenStringWithEscapedCommasWhenCaptureStringIsCalledThenCommasAreCaptured)
+{
+
+ // Test the capture string function.
+
+ // Given
+
+ wxString CaptureStringData = "Here we go\\, an \"example\" of escaping string.";
+
+ // When
+
CaptureString(&CaptureStringData, false);
+
+ // Then
+
ASSERT_EQ("Here we go, an \"example\" of escaping string.", CaptureStringData.ToStdString());
- CaptureStringData = "Lets put some \\nnew \\nlines \\nin \\nhere.";
+}
+
+TEST(CommonFunctions, GivenStringWithEscapedNewlinesWhenCaptureStringIsCalledThenNewlinesAreCaptured)
+{
+
+ // Test the capture string function.
+
+ // Given
+
+ wxString CaptureStringData = "Lets put some \\nnew \\nlines \\nin \\nhere.";
+
+ // When
+
CaptureString(&CaptureStringData, false);
+
+ // Then
+
ASSERT_EQ("Lets put some \nnew \nlines \nin \nhere.", CaptureStringData.ToStdString());
- CaptureStringData = "A:\\\\path\\\\example\\\\lets\\\\have\\\\some\\\\fun";
+}
+
+TEST(CommonFunctions, GivenStringWithEscapedBackslashesWhenCaptureStringIsCalledThenBackslashesAreCaptured)
+{
+
+ // Test the capture string function.
+
+ // Given
+
+ wxString CaptureStringData = "A:\\\\path\\\\example\\\\lets\\\\have\\\\some\\\\fun";
+
+ // When
+
CaptureString(&CaptureStringData, false);
+
+ // Then
+
ASSERT_EQ("A:\\path\\example\\lets\\have\\some\\fun", CaptureStringData.ToStdString());
}
-TEST(CommonFunctions, ResetUnusedString){
+TEST(CommonFunctions, GivenStringWithSeveralBackslashesWhenResetUnusedStringIsCalledThenStringIsReset)
+{
// Tests for resetting an unused string.
+ // Given
+
wxString ResetUnusedStringData = "Random string with a \\\\\\\\serverpath\\\\location";
+
+ // When
+
ResetUnusedString(&ResetUnusedStringData);
+
+ // Then
+
ASSERT_EQ("Random string with a \\\\serverpath\\location", ResetUnusedStringData.ToStdString());
- ResetUnusedStringData = "Some text \\nwith new \\nlines!";
- ResetUnusedString(&ResetUnusedStringData);
- ASSERT_EQ("Some text \nwith new \nlines!", ResetUnusedStringData.ToStdString());
+}
+
+TEST(CommonFunctions, GivenStringWithNewlinesWhenResetUnusedStringIsCalledThenStringIsFormatted)
+{
+
+ // Tests for resetting an unused string.
+
+ // Given
- ResetUnusedStringData = "Some text \\nwith new \\nlines!";
+ wxString ResetUnusedStringData = "Some text \\nwith new \\nlines!";
+
+ // When
+
ResetUnusedString(&ResetUnusedStringData);
+
+ // Then
+
ASSERT_EQ("Some text \nwith new \nlines!", ResetUnusedStringData.ToStdString());
+
+}
+
+TEST(CommonFunctions, GivenStringWithSeveralCharactersWhenResetUnusedStringThenStringIsFormatted)
+{
+
+ // Tests for resetting an unused string.
+
+ // Given
- ResetUnusedStringData = "And now the list of characters: \\\\ \\n \\; \\,";
+ wxString ResetUnusedStringData = "And now the list of characters: \\\\ \\n \\; \\,";
+
+ // When
+
ResetUnusedString(&ResetUnusedStringData);
+
+ // Then
+
ASSERT_EQ("And now the list of characters: \\ \n ; ,", ResetUnusedStringData.ToStdString());
}
-TEST(CommonFunctions, ConvertToHTML){
+TEST(CommonFunctions, GivenStringWhenConvertToHTMLIsCalledThenStringisHTMLEscaped)
+{
// Tests for converting data for inserting into a HTML
// formatted document.
+ // Given
+
wxString ConvertToHTMLData = "The test line where < is probably better than >!";
+
+ // When
+
ConvertToHTML(&ConvertToHTMLData);
+
+ // Then
+
ASSERT_EQ("The test line where < is probably better than >!", ConvertToHTMLData.ToStdString());
- ConvertToHTMLData = "More testing &<>\n";
+}
+
+TEST(CommonFunctions, GivenStringWithNewlineWhenConvertToHTMLIsCalledThenStringIsHTMLEscapedWithFormattedNewline)
+{
+
+ // Tests for converting data for inserting into a HTML
+ // formatted document.
+
+ // Given
+
+ wxString ConvertToHTMLData = "More testing &<>\n";
+
+ // When
+
ConvertToHTML(&ConvertToHTMLData);
+
+ // Then
+
ASSERT_EQ("More testing &<><br>", ConvertToHTMLData.ToStdString());
- ConvertToHTMLData = "This is the first line.\nThis is the second line.\nThis is the third line.";
+}
+
+TEST(CommonFunctions, GivenStringWithSeveralLinesWhenConvertToHTMLIsCalledThenStringIsHTMLEscapedWithFormattedNewlines)
+{
+
+ // Tests for converting data for inserting into a HTML
+ // formatted document.
+
+ // Given
+
+ wxString ConvertToHTMLData = "This is the first line.\nThis is the second line.\nThis is the third line.";
+
+ // When
+
ConvertToHTML(&ConvertToHTMLData);
+
+ // Then
+
ASSERT_EQ("This is the first line.<br>This is the second line.<br>This is the third line.", ConvertToHTMLData.ToStdString());
}
-TEST(CommonFunctions, MapDataExists){
+static std::map<int,int> mapExample =
+{
+ { 0, 1 }, { 1, 1 }, { 2, 1 }, { 5, 1 }, { 500, 1 }, { 2415, 1 }
+};
+static int itemIndex = 0;
+
+bool mapExistsStatus = false;
+
+TEST(CommonFunctions, GivenMapExistsStatusIsFalseAndItemIndexIs0WhenMapDataExistsIsCalledThenConfirmItemIndex0DoesExist)
+{
+
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = false;
+ itemIndex = 0;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(true, mapExistsStatus);
+
+}
+
+TEST(CommonFunctions, GivenMapExistsStatusIsFalseAndItemIndexIs1WhenMapDataExistsIsCalledThenConfirmItemIndex1DoesExist)
+{
+
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = false;
+ itemIndex = 1;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(true, mapExistsStatus);
+
+}
+
+TEST(CommonFunctions, GivenMapExistsStatusIsFalseAndItemIndexIs2WhenMapDataExistsIsCalledThenConfirmItemIndex2DoesExist)
+{
+
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = false;
+ itemIndex = 2;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(true, mapExistsStatus);
+
+}
+
+TEST(CommonFunctions, GivenMapExistsStatusIsTrueAndItemIndexIs3WhenMapDataExistsIsCalledThenConfirmItemIndex3DoesntExist)
+{
+
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = true;
+ itemIndex = 3;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(false, mapExistsStatus);
+
+}
+
+TEST(CommonFunctions, GivenMapExistsStatusIsFalseAndItemIndexIs5WhenMapDataExistsIsCalledThenConfirmItemIndex5DoesExist)
+{
+
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = false;
+ itemIndex = 5;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(true, mapExistsStatus);
+
+}
+
+TEST(CommonFunctions, GivenMapExistsStatusIsTrueAndItemIndexIs6WhenMapDataExistsIsCalledThenConfirmItemIndex6DoesntExist)
+{
+
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = true;
+ itemIndex = 6;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(false, mapExistsStatus);
+
+}
+
+TEST(CommonFunctions, GivenMapExistsStatusIsFalseAndItemIndexIs499WhenMapDataExistsIsCalledThenConfirmItemIndex499DoesntExist)
+{
+
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = false;
+ itemIndex = 499;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(false, mapExistsStatus);
+
+}
+
+TEST(CommonFunctions, GivenMapExistsStatusIsFalseAndItemIndexIs500WhenMapDataExistsIsCalledThenConfirmItemIndex500DoesExist)
+{
+
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = false;
+ itemIndex = 500;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(true, mapExistsStatus);
+
+}
+
+TEST(CommonFunctions, GivenMapExistsStatusIsTrueAndItemIndexIs501WhenMapDataExistsIsCalledThenConfirmItemIndex501DoesntExist)
+{
// Tests for checking that map data exists.
- std::map<int,int> MapExample;
- int ItemIndex = 0;
+ // Given
- MapExample.insert(std::make_pair(0,1));
- MapExample.insert(std::make_pair(1,1));
- MapExample.insert(std::make_pair(2,1));
- MapExample.insert(std::make_pair(5,1));
- MapExample.insert(std::make_pair(500,1));
- MapExample.insert(std::make_pair(2415,1));
+ mapExistsStatus = true;
+ itemIndex = 501;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(false, mapExistsStatus);
- ASSERT_EQ(true, MapDataExists(&ItemIndex, &MapExample));
+}
- ItemIndex = 1;
- ASSERT_EQ(true, MapDataExists(&ItemIndex, &MapExample));
+TEST(CommonFunctions, GivenMapExistsStatusIsTrueAndItemIndexIs2414WhenMapDataExistsIsCalledThenConfirmItemIndex2414DoesntExist)
+{
- ItemIndex = 2;
- ASSERT_EQ(true, MapDataExists(&ItemIndex, &MapExample));
+ // Tests for checking that map data exists.
- ItemIndex = 3;
- ASSERT_EQ(false, MapDataExists(&ItemIndex, &MapExample));
+ // Given
- ItemIndex = 5;
- ASSERT_EQ(true, MapDataExists(&ItemIndex, &MapExample));
+ mapExistsStatus = true;
+ itemIndex = 2414;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(false, mapExistsStatus);
- ItemIndex = 6;
- ASSERT_EQ(false, MapDataExists(&ItemIndex, &MapExample));
+}
- ItemIndex = 499;
- ASSERT_EQ(false, MapDataExists(&ItemIndex, &MapExample));
+TEST(CommonFunctions, GivenMapExistsStatusIsFalseAndItemIndexIs2415WhenMapDataExistsIsCalledThenConfirmItemIndex2415DoesExist)
+{
- ItemIndex = 500;
- ASSERT_EQ(true, MapDataExists(&ItemIndex, &MapExample));
+ // Tests for checking that map data exists.
+
+ // Given
+
+ mapExistsStatus = false;
+ itemIndex = 2415;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(true, mapExistsStatus);
- ItemIndex = 501;
- ASSERT_EQ(false, MapDataExists(&ItemIndex, &MapExample));
+}
- ItemIndex = 2414;
- ASSERT_EQ(false, MapDataExists(&ItemIndex, &MapExample));
+TEST(CommonFunctions, GivenMapExistsStatusIsTrueAndItemIndexIs2416WhenMapDataExistsIsCalledThenConfirmItemIndex2416DoesntExist)
+{
- ItemIndex = 2415;
- ASSERT_EQ(true, MapDataExists(&ItemIndex, &MapExample));
+ // Tests for checking that map data exists.
- ItemIndex = 2416;
- ASSERT_EQ(false, MapDataExists(&ItemIndex, &MapExample));
+ // Given
+
+ mapExistsStatus = true;
+ itemIndex = 2416;
+
+ // When
+
+ mapExistsStatus = MapDataExists(&itemIndex, &mapExample);
+
+ // Then
+
+ ASSERT_EQ(false, mapExistsStatus);
}
\ No newline at end of file