Search notes:

Test for the Base64 C++ library

This is a simple test case to test my C++ Base64 library. The program encodes and decodes a few strings and then checks if both versions are equal. Additionally, it also checks the string's decoded version with their expected value.
The program exits with 1 if one of the tests is not successful and with 0 otherwise.
Only errors are reported. So, ideally, the tool runs without printing anything. See also issue 32.
#include "base64.h"
#include <iostream>

int main() {

  bool all_tests_passed = true;

//
// Note: this file (test.cpp) must be encoded in UTF-8
// for the following test, otherwise, the test item
// fails.
//
   const std::string orig =
    "René Nyffenegger\n"
    "http://www.renenyffenegger.ch\n"
    "passion for data\n";

    std::string encoded = base64_encode(reinterpret_cast<const unsigned char*>(orig.c_str()), orig.length());
    std::string decoded = base64_decode(encoded);

    if (encoded != "UmVuw6kgTnlmZmVuZWdnZXIKaHR0cDovL3d3dy5yZW5lbnlmZmVuZWdnZXIuY2gKcGFzc2lvbiBmb3IgZGF0YQo=") {
      std::cout << "Encoding is wrong" << std::endl;
      all_tests_passed = false;
    }

    if (decoded != orig) {
      std::cout << "decoded != orig" << std::endl;
      all_tests_passed = false;
    }

 // Test all possibilites of fill bytes (none, one =, two ==)
 // References calculated with: https://www.base64encode.org/

    std::string rest0_original = "abc";
    std::string rest0_reference = "YWJj";

    std::string rest0_encoded = base64_encode(reinterpret_cast<const unsigned char*>(rest0_original.c_str()),
      rest0_original.length());
    std::string rest0_decoded = base64_decode(rest0_encoded);

    if (rest0_decoded != rest0_original) {
      std::cout << "rest0_decoded != rest0_original" << std::endl;
      all_tests_passed = false;
    }
    if (rest0_reference != rest0_encoded) {
      std::cout << "rest0_reference != rest0_encoded" << std::endl;
      all_tests_passed = false;
    }

 // std::cout << "encoded:   " << rest0_encoded << std::endl;
 // std::cout << "reference: " << rest0_reference << std::endl;
 // std::cout << "decoded:   " << rest0_decoded << std::endl << std::endl;

    std::string rest1_original = "abcd";
    std::string rest1_reference = "YWJjZA==";

    std::string rest1_encoded = base64_encode(reinterpret_cast<const unsigned char*>(rest1_original.c_str()),
      rest1_original.length());
    std::string rest1_decoded = base64_decode(rest1_encoded);

    if (rest1_decoded != rest1_original) {
      std::cout << "rest1_decoded != rest1_original" << std::endl;
      all_tests_passed = false;
    }
    if (rest1_reference != rest1_encoded) {
      std::cout << "rest1_reference != rest1_encoded" << std::endl;
      all_tests_passed = false;
    }

 // std::cout << "encoded:   " << rest1_encoded << std::endl;
 // std::cout << "reference: " << rest1_reference << std::endl;
 // std::cout << "decoded:   " << rest1_decoded << std::endl << std::endl;

    std::string rest2_original = "abcde";
    std::string rest2_reference = "YWJjZGU=";

    std::string rest2_encoded = base64_encode(reinterpret_cast<const unsigned char*>(rest2_original.c_str()),
      rest2_original.length());
    std::string rest2_decoded = base64_decode(rest2_encoded);

    if (rest2_decoded != rest2_original) {
      std::cout << "rest2_decoded != rest2_original" << std::endl;
      all_tests_passed = false;
    }
    if (rest2_reference != rest2_encoded) {
      std::cout << "rest2_reference != rest2_encoded" << std::endl;
      all_tests_passed = false;
    }

 // std::cout << "encoded:   " << rest2_encoded << std::endl;
 // std::cout << "reference: " << rest2_reference << std::endl;
 // std::cout << "decoded:   " << rest2_decoded << std::endl << std::endl;
 //

 // --------------------------------------------------------------
 //
 // Data that is 17 bytes long requires one padding byte when
 // base-64 encoded. Such an encoded string could not correctly
 // be decoded when encoded with «url semantics». This bug
 // was discovered by https://github.com/kosniaz. The following
 // test checks if this bug was fixed:
 //
    std::string a17_orig    = "aaaaaaaaaaaaaaaaa";
    std::string a17_encoded     = base64_encode(a17_orig, false);
    std::string a17_encoded_url = base64_encode(a17_orig, true );

    if (a17_encoded != "YWFhYWFhYWFhYWFhYWFhYWE=") {
        std::cout << "Failed to encode a17" << std::endl;
        all_tests_passed = false;
    }

    if (a17_encoded_url != "YWFhYWFhYWFhYWFhYWFhYWE.") {
        std::cout << "Failed to encode a17 (url)" << std::endl;
        all_tests_passed = false;
    }

    if (base64_decode(a17_encoded_url) != a17_orig) {
        std::cout << "Failed to decode a17 (url)" << std::endl;
        all_tests_passed = false;
    }

    if (base64_decode(a17_encoded    ) != a17_orig) {
        std::cout << "Failed to decode a17 (no url)" << std::endl;
        all_tests_passed = false;
    }

 // --------------------------------------------------------------

 // characters 63 and 64 / URL encoding

    std::string s_6364 = "\x03" "\xef" "\xff" "\xf9";

    std::string s_6364_encoded     = base64_encode(s_6364, false);
    std::string s_6364_encoded_url = base64_encode(s_6364, true );

    if (s_6364_encoded    != "A+//+Q==") {
        std::cout << "Failed to encode_6364 (no url)" << std::endl;
        all_tests_passed = false;
    }

    if (s_6364_encoded_url!= "A-__-Q..") {
        std::cout << "Failed to encode_6364 (url)" << std::endl;
        all_tests_passed = false;
    }

    if (base64_decode(s_6364_encoded    ) != s_6364) {
        std::cout << "Failed to decode s_6364_encoded" << std::endl;
        all_tests_passed = false;
    }

    if (base64_decode(s_6364_encoded_url) != s_6364) {
        std::cout << "Failed to decode s_6364_encoded_url" << std::endl;
        all_tests_passed = false;
    }

    std::string numbers =
        "one two three four five six seven eight nine ten eleven twelve "
        "thirteen fourteen fivteen sixteen seventeen eighteen nineteen "
        "twenty twenty-one";
    std::string encoded_mime = base64_encode_mime(numbers);

    std::string encoded_mime_expeced =
         "b25lIHR3byB0aHJlZSBmb3VyIGZpdmUgc2l4IHNldmVuIGVpZ2h0IG5pbmUgdGVuIGVsZXZlbiB0\n"
         "d2VsdmUgdGhpcnRlZW4gZm91cnRlZW4gZml2dGVlbiBzaXh0ZWVuIHNldmVudGVlbiBlaWdodGVl\n"
         "biBuaW5ldGVlbiB0d2VudHkgdHdlbnR5LW9uZQ==";

    if (encoded_mime != encoded_mime_expeced) {
        std::cout << "Failed: base64_encode_mime s_6364_encoded" << std::endl;
        all_tests_passed = false;
    }

 //
 // Set 2nd parameter remove_linebreaks to true in order decode a
 // mime encoded string:
 //
    std::string decoded_mime = base64_decode(encoded_mime, true);

    if (decoded_mime != numbers) {
        std::cout << "Failed: base64_decode(..., true)" << std::endl;
        all_tests_passed = false;
    }

 // ----------------------------------------------

    std::string unpadded_input   = "YWJjZGVmZw"; // Note the 'missing' "=="
    std::string unpadded_decoded = base64_decode(unpadded_input);
    if (unpadded_decoded != "abcdefg") {
        std::cout << "Failed to decode unpadded input " << unpadded_input << std::endl;
        all_tests_passed = false;
    }

    unpadded_input   = "YWJjZGU"; // Note the 'missing' "="
    unpadded_decoded = base64_decode(unpadded_input);
    if (unpadded_decoded != "abcde") {
        std::cout << "Failed to decode unpadded input " << unpadded_input << std::endl;
        std::cout << unpadded_decoded << std::endl;
        all_tests_passed = false;
    }

    unpadded_input   = "";
    unpadded_decoded = base64_decode(unpadded_input);
    if (unpadded_decoded != "") {
        std::cout << "Failed to decode unpadded input " << unpadded_input << std::endl;
        std::cout << unpadded_decoded << std::endl;
        all_tests_passed = false;
    }

    unpadded_input   = "YQ";
    unpadded_decoded = base64_decode(unpadded_input);
    if (unpadded_decoded != "a") {
        std::cout << "Failed to decode unpadded input " << unpadded_input << std::endl;
        std::cout << unpadded_decoded << std::endl;
        all_tests_passed = false;
    }

    unpadded_input   = "YWI";
    unpadded_decoded = base64_decode(unpadded_input);
    if (unpadded_decoded != "ab") {
        std::cout << "Failed to decode unpadded input " << unpadded_input << std::endl;
        std::cout << unpadded_decoded << std::endl;
        all_tests_passed = false;
    }

 // --------------------------------------------------------------
 //
 //    2022-11-01
 //       Replace
 //          encoded_string[…] with encoded_sring.at(…)
 //       in
 //          decode()     
 //
    try {
       std::string not_null_terminated = std::string(1, 'a');
       std::string not_null_decoded    = base64_decode(not_null_terminated);

       std::cout << "Expected a std::out_of_range exception" << std::endl;
       all_tests_passed = false;
    }
    catch (std::out_of_range const&) {}

 // --------------------------------------------------------------

#if __cplusplus >= 201703L
 //
 // Test the string_view interface (which required C++17)
 //
    std::string_view sv_orig    = "foobarbaz";
    std::string_view sv_encoded = base64_encode(sv_orig);

    if (sv_encoded != "Zm9vYmFyYmF6") {
       std::cout << "Failed to encode with string_view" << std::endl;
       all_tests_passed = false;
    }

    std::string_view sv_decoded = base64_decode(sv_encoded);

    if (sv_decoded != sv_orig) {
       std::cout << "Failed to decode with string_view" << std::endl;
       all_tests_passed = false;
    }

#endif

    if (all_tests_passed) return 0;
    return 1;
}
Github repository cpp-base64, path: /test.cpp

See also

measure-time.cpp.

Index