/*
    Copyright (c) 2020 Intel Corporation

    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.
*/


#include "common/test.h"

#include "common/utils.h"
#include "common/graph_utils.h"

#include "oneapi/tbb/flow_graph.h"
#include "oneapi/tbb/task_arena.h"
#include "oneapi/tbb/global_control.h"

#include "conformance_flowgraph.h"

//! \file conformance_priority_queue_node.cpp
//! \brief Test for [flow_graph.priority_queue_node] specification

/*
TODO: implement missing conformance tests for priority_queue_node:
  - [ ] Explicit test that `size_type' is defined and accessible.
  - [ ] The copy constructor and copy assignment are called for the node's type template parameter.
  - [ ] Check `Compare' type requirements from [alg.sorting] ISO C++.
  - [ ] Write tests for the constructors.
  - [ ] Based on the reconsideration of the `try_put()' and `try_get()' methods, rethink the testing    of these methods.  - [ ] Improve `test_buffering' by checking that additional `try_get()' does not receive the same
    value.
*/

template<typename T>
void test_inheritance(){
    using namespace oneapi::tbb::flow;

    CHECK_MESSAGE( (std::is_base_of<graph_node, priority_queue_node<T>>::value), "priority_queue_node should be derived from graph_node");
    CHECK_MESSAGE( (std::is_base_of<receiver<T>, priority_queue_node<T>>::value), "priority_queue_node should be derived from receiver<T>");
    CHECK_MESSAGE( (std::is_base_of<sender<T>, priority_queue_node<T>>::value), "priority_queue_node should be derived from sender<T>");
}

void test_copies(){
    using namespace oneapi::tbb::flow;

    graph g;
    priority_queue_node<int> n(g);
    priority_queue_node<int> n2(n);

}

void test_buffering(){
    oneapi::tbb::flow::graph g;

    oneapi::tbb::flow::priority_queue_node<int> node(g);
    oneapi::tbb::flow::limiter_node<int> rejecter(g, 0);

    oneapi::tbb::flow::make_edge(node, rejecter);
    node.try_put(1);
    g.wait_for_all();

    int tmp = -1;
    CHECK_MESSAGE( (node.try_get(tmp) == true), "try_get after rejection should succeed");
    CHECK_MESSAGE( (tmp == 1), "try_get after rejection should set value");
}

void test_forwarding(){
    oneapi::tbb::flow::graph g;

    oneapi::tbb::flow::priority_queue_node<int> node1(g);
    test_push_receiver<int> node2(g);
    test_push_receiver<int> node3(g);

    oneapi::tbb::flow::make_edge(node1, node2);
    oneapi::tbb::flow::make_edge(node1, node3);

    node1.try_put(1);
    g.wait_for_all();

    int c2 = get_count(node2), c3 = get_count(node3);
    CHECK_MESSAGE( (c2 != c3 ), "Only one descendant the node needs to receive");
    CHECK_MESSAGE( (c2 + c3 == 1 ), "All messages need to be received");
}

void test_behavior(){
    oneapi::tbb::flow::graph g;

    oneapi::tbb::flow::priority_queue_node<int, std::greater<int>> node(g);

    node.try_put(2);
    node.try_put(3);
    node.try_put(1);
    g.wait_for_all();

    int tmp = -1;
    CHECK_MESSAGE( (node.try_get(tmp)), "Get should succeed");
    CHECK_MESSAGE( (tmp == 1), "Values should get sorted");
    CHECK_MESSAGE( (node.try_get(tmp)), "Get should succeed");
    CHECK_MESSAGE( (tmp == 2), "Values should get sorted");
    CHECK_MESSAGE( (node.try_get(tmp)), "Get should succeed");
    CHECK_MESSAGE( (tmp == 3), "Values should get sorted");
}

//! Test priority_queue_node messages
//! \brief \ref requirement
TEST_CASE("priority_queue_node messages"){
    test_behavior();
}

//! Test priority_queue_node single-push
//! \brief \ref requirement
TEST_CASE("priority_queue_node single-push"){
    test_forwarding();
}

//! Test priority_queue_node buffering
//! \brief \ref requirement
TEST_CASE("priority_queue_node buffering"){
    test_buffering();
}

//! Test copy constructor
//! \brief \ref interface
TEST_CASE("priority_queue_node copy constructor"){
    test_copies();
}

//! Test inheritance relations
//! \brief \ref interface
TEST_CASE("priority_queue_node superclasses"){
    test_inheritance<int>();
    test_inheritance<void*>();
}