Adding a new file where we can put basic tests. (#203)

* Adding a new file where we can put basic tests.

* Adding a test for the reverse.

* More tests.

* Testing all examples from the README.

* Minor fix

* Build everything

Author: lemire

.github/workflows/ubuntu-sanitized.yml

@@ -30,6 +30,6 @@ jobs:
         env:
           CXX: g++-12
       - name: Build
-        run: cmake --build build --target wpt_tests --target from_file_tests --target demo --target basic_fuzzer -j=2
+        run: cmake --build build -j=2
       - name: Test
         run: ctest --output-on-failure --test-dir build

README.md

@@ -30,16 +30,16 @@ if(url) { /* URL is valid */ }
 ada::result url = ada::parse("https://www.google.com");
 url->set_username("username");
 url->set_password("password");
-// ada->get_href() will return "https://username:password@www.google.com"
+// ada->get_href() will return "https://username:password@www.google.com/"
 ```
 
 - Get/Update Protocol
 
 ```cpp
 ada::result url = ada::parse("https://www.google.com");
 url->set_protocol("wss");
-// url->get_protocol() will return "wss"
-// url->get_href() will return "wss://www.google.com"
+// url->get_protocol() will return "wss:"
+// url->get_href() will return "wss://www.google.com/"
 ```
 
 - Get/Update host

tests/CMakeLists.txt

@@ -19,4 +19,5 @@ endif()
 
 add_cpp_test(basic_fuzzer)
 add_cpp_test(from_file_tests)
+add_cpp_test(basic_tests)
 

tests/basic_tests.cpp

@@ -0,0 +1,143 @@
+#include "ada.h"
+
+#include <cstdlib>
+#include <iostream>
+
+#define TEST_START()                                                           \
+  do {                                                                         \
+    std::cout << "> Running " << __func__ << " ..." << std::endl;              \
+  } while (0);
+#define RUN_TEST(ACTUAL)                                                       \
+  do {                                                                         \
+    if (!(ACTUAL)) {                                                           \
+      return false;                                                            \
+    }                                                                          \
+  } while (0);
+#define TEST_FAIL(MESSAGE)                                                     \
+  do {                                                                         \
+    std::cerr << "FAIL: " << (MESSAGE) << std::endl;                           \
+    return false;                                                              \
+  } while (0);
+#define TEST_SUCCEED()                                                         \
+  do {                                                                         \
+    return true;                                                               \
+  } while (0);
+#define TEST_ASSERT(LHS, RHS, MESSAGE)                                         \
+  do {                                                                         \
+    if (LHS != RHS)  {                                                         \
+      std::cerr << "Mismatch: '" << LHS << "' - '" << RHS << "'" << std::endl; \
+      TEST_FAIL(MESSAGE);                                                      \
+    }                                                                          \
+  } while (0);                                                                 \
+
+
+bool set_host_should_return_false_sometimes() {
+    TEST_START()
+    ada::result r = ada::parse("mailto:a@b.com");
+    bool b = r->set_host("something");
+    TEST_ASSERT(b, false, "set_host should return false")
+    TEST_SUCCEED() 
+}
+
+bool set_host_should_return_true_sometimes() {
+    TEST_START()
+    ada::result r = ada::parse("https://www.google.com");
+    bool b = r->set_host("something");
+    TEST_ASSERT(b, true, "set_host should return true")
+    TEST_SUCCEED() 
+}
+
+
+bool set_hostname_should_return_false_sometimes() {
+    TEST_START()
+    ada::result r = ada::parse("mailto:a@b.com");
+    bool b = r->set_hostname("something");
+    TEST_ASSERT(b, false, "set_hostname should return false")
+    TEST_SUCCEED() 
+}
+
+bool set_hostname_should_return_true_sometimes() {
+    TEST_START()
+    ada::result r = ada::parse("https://www.google.com");
+    bool b = r->set_hostname("something");
+    TEST_ASSERT(b, true, "set_hostname should return true")
+    TEST_SUCCEED() 
+}
+
+bool readme1() {
+    TEST_START()
+    ada::result url = ada::parse("https://www.google.com");
+    TEST_ASSERT(bool(url), true, "URL is valid")
+    TEST_SUCCEED() 
+}
+
+bool readme2() {
+    TEST_START()
+    ada::result url = ada::parse("https://www.google.com");
+    url->set_username("username");
+    url->set_password("password");
+    TEST_ASSERT(url->get_href(), "https://username:password@www.google.com/", "href returned bad result")
+    TEST_SUCCEED() 
+}
+
+bool readme3() {
+    TEST_START()
+    ada::result url = ada::parse("https://www.google.com");
+    url->set_protocol("wss");
+    TEST_ASSERT(url->get_protocol(), "wss:", "get_protocol returned bad result")
+    TEST_ASSERT(url->get_href(), "wss://www.google.com/", "get_href returned bad result")
+
+    TEST_SUCCEED() 
+}
+
+bool readme4() {
+    TEST_START()
+    ada::result url = ada::parse("https://www.google.com");
+    url->set_host("github.com");
+    TEST_ASSERT(url->get_host(), "github.com", "get_host returned bad result")
+    TEST_SUCCEED() 
+}
+
+bool readme5() {
+    TEST_START()
+    ada::result url = ada::parse("https://www.google.com");
+    url->set_port("8080");
+    TEST_ASSERT(url->get_port(), "8080", "get_port returned bad result")
+    TEST_SUCCEED() 
+}
+
+bool readme6() {
+    TEST_START()
+    ada::result url = ada::parse("https://www.google.com");
+    url->set_pathname("/my-super-long-path");
+    TEST_ASSERT(url->get_pathname(), "/my-super-long-path", "get_pathname returned bad result")
+    TEST_SUCCEED() 
+}
+
+bool readme7() {
+    TEST_START()
+    ada::result url = ada::parse("https://www.google.com");
+    url->set_search("target=self");
+    TEST_ASSERT(url->get_search(), "?target=self", "get_pathname returned bad result");
+    TEST_SUCCEED() 
+}
+
+bool readme8() {
+    TEST_START()
+    ada::result url = ada::parse("https://www.google.com");
+    url->set_hash("is-this-the-real-life");
+    TEST_ASSERT(url->get_hash(), "#is-this-the-real-life", "get_hash returned bad result");
+    TEST_SUCCEED() 
+}
+
+int main() {
+    bool success = set_host_should_return_false_sometimes()
+     && set_host_should_return_true_sometimes()
+     && set_hostname_should_return_false_sometimes()
+     && set_hostname_should_return_true_sometimes()
+     && readme1() && readme2() && readme3() 
+     && readme4() && readme5() && readme6()
+      && readme7(); 
+    if(success) { return EXIT_SUCCESS; }
+    return EXIT_FAILURE;
+}