test_ngx_diffstub_internal.cpp

/*
Copyright 2023 Comcast

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
 */

#define DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN
#include <string>
#include <cstring>
#include "doctest.h"
#include "ngx_diffstub_internal.hpp"
#include "pugixml.hpp"

/*  
    Helper function (recursive) for comparing two xml nodes to be identical from different documents
    Optimization: Consider moving into application to remove the XMLElement class
*/
bool compare_xml_nodes(const pugi::xml_node& val_node, const pugi::xml_node& act_node) {
    if(val_node.type() != act_node.type()) {
        return false; // Node types differ
    }

    if (std::strcmp(val_node.name(), act_node.name()) != 0) {
        return false; // Element names differ
    }

    size_t num_attr_val = std::distance(val_node.attributes().begin(), val_node.attributes().end());
    size_t num_attr_act = std::distance(act_node.attributes().begin(), act_node.attributes().end());

    if (num_attr_val == num_attr_act) {
        for (const pugi::xml_attribute& attr1 : val_node.attributes()) {
            pugi::xml_attribute attr2 = act_node.attribute(attr1.name());

            if (!attr2 || std::strcmp(attr1.value(), attr2.value())) {
                return false; // Attribute values differ or missing
            }
        }
    } else {
        return false; // Number of attributes differ
    }
    
    size_t num_child_val = std::distance(val_node.children().begin(), val_node.children().end());
    size_t num_child_act = std::distance(act_node.children().begin(), act_node.children().end());
    if (num_child_act == num_child_val) {
        for (pugi::xml_node child1 : val_node.children()) {
            bool foundMatchingChild = false;
            for (pugi::xml_node child2 : act_node.children()) {
                // Recursive call to compare children
                if (compare_xml_nodes(child1, child2)) {
                    foundMatchingChild = true;
                    break;
                }
            }
            if (!foundMatchingChild) {
                return false; // Child element missing or different
            }
        }
    } else {
        return false; // Number of children differ
    }

    // Compare text content, if no text content exists, an empty string is returned, so this works for non-text nodes aswell
    if (std::strcmp(val_node.text().get(), act_node.text().get()) != 0) {
        return false; // Text content differs
    }

    return true; // Everything matches
}

bool execute_test_case(const char* old_mpd, const char* new_mpd, const char* mpd_patch_val_file) {
    const char* mpd_patch_act = morph_diffs(old_mpd, new_mpd);

    std::cerr << "\n MORPH DIFFS OUTPUT: \n" << mpd_patch_act << std::endl;
    std::cerr << "----------------------" << std::endl;

    pugi::xml_document validate_patch, actual_patch;
    if (!validate_patch.load_file(mpd_patch_val_file)) {
        FAIL("FAILED TO LOAD TEST VALIDATION FILE");
    }
    if (!actual_patch.load_string(mpd_patch_act)) {
        FAIL("FAILED TO LOAD GENERATED PATCH STRING");
    }

    // Free memory from c-string after constructing xml_document
    free((void*) mpd_patch_act);

    pugi::xml_node root_val = validate_patch.first_child();
    pugi::xml_node root_act = actual_patch.first_child();

    return compare_xml_nodes(root_val, root_act);
}


/* ATTRIBUTE TEST FUNCTIONS */
/*
    TODO: Current logic replaces entire element if no children are present.
    Better to replace single attribute instead of the entire element and update test case
 */
TEST_CASE("TestAddAttrNoChild") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_add_attr_no_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_add_attr_no_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestAddAttrWithChild") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_add_attr_with_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_add_attr_with_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestRemoveAttrNoChild") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rem_attr_no_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rem_attr_no_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestRemoveAttrWithChild") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rem_attr_with_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rem_attr_with_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestReplaceAttrNoChild") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rep_attr_no_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rep_attr_no_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestReplaceAttrWithChild") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rep_attr_with_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rep_attr_with_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


/* STANDARD ELEMENT TEST FUNCTIONS */
TEST_CASE("TestAddStandardElementNoChildBeginning") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_add_elem_no_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_add_elem_no_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestRemoveStandardElementNoChild") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rem_elem_no_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rem_elem_no_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}

/* LOCICALLY LOOKS THE SAME AS REPLACE ATTRIBUTE*/
TEST_CASE("TestReplaceStandardElementNoChild") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rep_attr_no_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rep_attr_no_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


// This is currently not passing the test
#if 0
TEST_CASE("TestAddStandardElementWithChildren") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_add_elem_with_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_add_elem_with_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}
#endif


TEST_CASE("TestRemoveStandardElementWithChildren") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rem_elem_with_child.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rem_elem_with_child-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}

/* TEXT ELEMENT TEST FUNCTIONS */
TEST_CASE("TestAddTextElement") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_add_text_elem.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_add_text_elem-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestRemoveTextElement") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_2.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rem_text_elem.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rem_text_elem-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestReplaceTextElement") {
    const char* old_mpd = "./mpd_samples/test_cases/test_base_2.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_rep_text_elem.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_rep_text_elem-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestMultiSegmentEditRemoveReplace") {
    const char* old_mpd = "./mpd_samples/test_cases/test_origin_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_origin_segment_remove_before_replace.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_origin_segment_remove_before_replace-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestAddSingleSegmentToMiddleTimeline") {
    const char* old_mpd = "./mpd_samples/test_cases/test_origin_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_origin_single_segment_add_middle_timeline.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_origin_single_segment_add_middle_timeline-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestAddConsecutiveSegmentToMiddleTimeline") {
    const char* old_mpd = "./mpd_samples/test_cases/test_origin_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_origin_consecutive_segment_add_middle_timeline.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_origin_consecutive_segment_add_middle_timeline-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestAddNonConsecutiveSegments") {
    const char* old_mpd = "./mpd_samples/test_cases/test_origin_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_origin_non_cons_add_segment.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_origin_non_cons_add_segment-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestAddConsecutiveSegmentsBeginning") {
    const char* old_mpd = "./mpd_samples/test_cases/test_origin_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_origin_cons_add_segment_beginning.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_origin_cons_add_segment_beginning-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}


TEST_CASE("TestReplaceSingletonList") {
    const char* old_mpd = "./mpd_samples/test_cases/test_replace_singleton_list_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_replace_singleton_list_2.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_replace_singleton_list-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}

#if 0
TEST_CASE("TestAddReplaceRemAttrib") {
    const char* old_mpd = "./mpd_samples/test_cases/test_origin_1.mpd";
    const char* new_mpd = "./mpd_samples/test_cases/test_add_rep_rem_attrib.mpd";
    const char* mpd_patch_val_file = "./mpd_samples/test_cases/test_replace_singleton_list-patch.mpd";
    
    REQUIRE(execute_test_case(old_mpd, new_mpd, mpd_patch_val_file));
}
#endif